C# Class Rock.Field.Types.TextFieldType

Inheritance: FieldType

Show file Open project: SparkDevNetwork/Rock

Public Methods

Method	Description
ConfigurationControls ( ) : List	Creates the HTML controls required to configure this type of field
ConfigurationKeys ( ) : List	Returns a list of the configuration keys
ConfigurationValues ( List controls ) : ConfigurationValue>.Dictionary	Gets the configuration value.
EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : Control	Creates the control(s) necessary for prompting user for a new value
FilterCompareControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control	Gets the filter compare control.
FormatValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed ) : string	Returns the field's current value(s)
FormatValueAsHtml ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed = false ) : string	Formats the value as HTML.
GetFilterCompareValue ( Control control, FilterMode filterMode ) : string	Gets the filter compare value.
GetFilterValues ( Control filterControl, ConfigurationValue>.Dictionary configurationValues, FilterMode filterMode ) : List	Gets the filter values.
HasFilterControl ( ) : bool	Determines whether [has filter control].
SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void	Sets the configuration value.
SortValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object	Returns the value that should be used for sorting, using the most appropriate datatype

Method Details

ConfigurationControls() public method

Creates the HTML controls required to configure this type of field

public ConfigurationControls ( ) : List
return	List

ConfigurationKeys() public method

Returns a list of the configuration keys

public ConfigurationKeys ( ) : List
return	List

ConfigurationValues() public method

Gets the configuration value.

public ConfigurationValues ( List controls ) : ConfigurationValue>.Dictionary
controls	List	The controls.
return	ConfigurationValue>.Dictionary

EditControl() public method

Creates the control(s) necessary for prompting user for a new value

public EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : Control
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
id	string	The id.
return	System.Web.UI.Control

FilterCompareControl() public method

Gets the filter compare control.

public FilterCompareControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
id	string	The identifier.
required	bool	if set to true [required].
filterMode	FilterMode	The filter mode.
return	System.Web.UI.Control

FormatValue() public method

Returns the field's current value(s)

public FormatValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed ) : string
parentControl	System.Web.UI.Control	The parent control.
value	string	Information about the value
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
condensed	bool	Flag indicating if the value should be condensed (i.e. for use in a grid column)
return	string

FormatValueAsHtml() public method

Formats the value as HTML.

public FormatValueAsHtml ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed = false ) : string
parentControl	System.Web.UI.Control	The parent control.
value	string	The value.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
condensed	bool	if set to true [condensed].
return	string

GetFilterCompareValue() public method

Gets the filter compare value.

public GetFilterCompareValue ( Control control, FilterMode filterMode ) : string
control	System.Web.UI.Control	The control.
filterMode	FilterMode	The filter mode.
return	string

GetFilterValues() public method

Gets the filter values.

public GetFilterValues ( Control filterControl, ConfigurationValue>.Dictionary configurationValues, FilterMode filterMode ) : List
filterControl	System.Web.UI.Control	The filter control.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
filterMode	FilterMode	The filter mode.
return	List

HasFilterControl() public method

Determines whether [has filter control].

public HasFilterControl ( ) : bool
return	bool

SetConfigurationValues() public method

Sets the configuration value.

public SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void
controls	List
configurationValues	ConfigurationValue>.Dictionary
return	void

SortValue() public method

Returns the value that should be used for sorting, using the most appropriate datatype

public SortValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object
parentControl	System.Web.UI.Control	The parent control.
value	string	The value.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
return	object