C# Class Rock.Utility.SettingsStringBase

A base class that provides common functions to create or parse versioned settings strings used by various Rock components.
Mostra file Open project: NewSpring/Rock

Public Methods

Method Description
FromSelectionString ( string selectionString, string delimiter = SettingsDelimiter ) : void

Set values from a string representation of the settings.

ToSelectionString ( ) : string

Gets a string representation of the settings.

ToString ( ) : string

Returns a System.String that represents this instance.

Protected Methods

Method Description
OnGetParameters ( ) : IEnumerable

Gets an ordered set of property values that can be used to construct the settings string.

OnSetParameters ( int version, IReadOnlyList parameters ) : void

Set the property values parsed from a settings string.

Method Details

FromSelectionString() public method

Set values from a string representation of the settings.
public FromSelectionString ( string selectionString, string delimiter = SettingsDelimiter ) : void
selectionString string A delimited string representing the settings.
delimiter string The delimiter used to separate the setting values.
return void

OnGetParameters() protected abstract method

Gets an ordered set of property values that can be used to construct the settings string.
protected abstract OnGetParameters ( ) : IEnumerable
return IEnumerable

OnSetParameters() protected abstract method

Set the property values parsed from a settings string.
protected abstract OnSetParameters ( int version, IReadOnlyList parameters ) : void
version int The version number of the parameter set.
parameters IReadOnlyList An ordered collection of strings representing the parameter values.
return void

ToSelectionString() public method

Gets a string representation of the settings.
public ToSelectionString ( ) : string
return string

ToString() public method

Returns a System.String that represents this instance.
public ToString ( ) : string
return string