C# Class Rock.Field.Types.EmailFieldType

Inheritance: FieldType
Show file Open project: NewSpring/Rock

Public Methods

Method Description
EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : Control

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

FilterValueControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control

Gets the filter value control with the specified FilterMode

FormatFilterValueValue ( ConfigurationValue>.Dictionary configurationValues, string value ) : string

Formats the filter value value.

FormatValue ( System parentControl, string value, ConfigurationValue>.System 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.

IsValid ( string value, bool required, string &message ) : bool

Tests the value to ensure that it is a valid value. If not, message will indicate why

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

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
return Control

FilterValueControl() public method

Gets the filter value control with the specified FilterMode
public FilterValueControl ( 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 Control

FormatFilterValueValue() public method

Formats the filter value value.
public FormatFilterValueValue ( ConfigurationValue>.Dictionary configurationValues, string value ) : string
configurationValues ConfigurationValue>.Dictionary The configuration values.
value string The value.
return string

FormatValue() public method

Returns the field's current value(s)
public FormatValue ( System parentControl, string value, ConfigurationValue>.System configurationValues, bool condensed ) : string
parentControl System The parent control.
value string Information about the value
configurationValues ConfigurationValue>.System
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 Control The parent control.
value string The value.
configurationValues ConfigurationValue>.Dictionary The configuration values.
condensed bool if set to true [condensed].
return string

IsValid() public method

Tests the value to ensure that it is a valid value. If not, message will indicate why
public IsValid ( string value, bool required, string &message ) : bool
value string
required bool
message string
return bool

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 Control The parent control.
value string The value.
configurationValues ConfigurationValue>.Dictionary The configuration values.
return object