C# Class Rock.Field.Types.BooleanFieldType

Field Type used to save a boolean value. Stored as "True" or "False"
Inheritance: FieldType
Afficher le fichier Open project: NewSpring/Rock

Méthodes publiques

Méthode Description
AttributeFilterExpression ( ConfigurationValue>.Dictionary configurationValues, List filterValues, System.Linq.Expressions.ParameterExpression parameterExpression ) : Expression

Gets a filter expression for an attribute value.

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

Renders the controls necessary for prompting user for a new value and adds them to the parentControl

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

Gets the filter compare control with the specified FilterMode

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

Gets the filter value control.

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

Formats the filter value value.

FormatValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed ) : string

Returns the field's current value(s)

GetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string

Reads new values entered by the user for the field

GetFilterCompareValue ( Control control, FilterMode filterMode ) : string

Gets the filter compare value.

GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string

Gets the filter value value.

GetFilterValues ( Control filterControl, ConfigurationValue>.Dictionary configurationValues, FilterMode filterMode ) : List

Gets the filter value.

HasFilterControl ( ) : bool

Determines whether this filter has a filter control

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

PropertyFilterExpression ( ConfigurationValue>.Dictionary configurationValues, List filterValues, Expression parameterExpression, string propertyName, Type propertyType ) : Expression

Gets a filter expression for an entity property value.

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

Sets the configuration value.

SetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void

Sets the value.

SetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void

Sets the filter value value.

SortValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object

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

ValueAsFieldType ( System parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object

Returns the value using the most appropriate datatype

Method Details

AttributeFilterExpression() public méthode

Gets a filter expression for an attribute value.
public AttributeFilterExpression ( ConfigurationValue>.Dictionary configurationValues, List filterValues, System.Linq.Expressions.ParameterExpression parameterExpression ) : Expression
configurationValues ConfigurationValue>.Dictionary The configuration values.
filterValues List The filter values.
parameterExpression System.Linq.Expressions.ParameterExpression The parameter expression.
Résultat System.Linq.Expressions.Expression

ConfigurationControls() public méthode

Creates the HTML controls required to configure this type of field
public ConfigurationControls ( ) : List
Résultat List

ConfigurationKeys() public méthode

Returns a list of the configuration keys
public ConfigurationKeys ( ) : List
Résultat List

ConfigurationValues() public méthode

Gets the configuration value.
public ConfigurationValues ( List controls ) : ConfigurationValue>.Dictionary
controls List The controls.
Résultat ConfigurationValue>.Dictionary

EditControl() public méthode

Renders the controls necessary for prompting user for a new value and adds them to the parentControl
public EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : Control
configurationValues ConfigurationValue>.Dictionary The configuration values.
id string
Résultat System.Web.UI.Control

FilterCompareControl() public méthode

Gets the filter compare control with the specified FilterMode
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.
Résultat System.Web.UI.Control

FilterValueControl() public méthode

Gets the filter value control.
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.
Résultat System.Web.UI.Control

FormatFilterValueValue() public méthode

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

FormatValue() public méthode

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)
Résultat string

GetEditValue() public méthode

Reads new values entered by the user for the field
public GetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string
control System.Web.UI.Control Parent control that controls were added to in the CreateEditControl() method
configurationValues ConfigurationValue>.Dictionary The configuration values.
Résultat string

GetFilterCompareValue() public méthode

Gets the filter compare value.
public GetFilterCompareValue ( Control control, FilterMode filterMode ) : string
control System.Web.UI.Control The control.
filterMode FilterMode The filter mode.
Résultat string

GetFilterValueValue() public méthode

Gets the filter value value.
public GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string
control System.Web.UI.Control The control.
configurationValues ConfigurationValue>.Dictionary The configuration values.
Résultat string

GetFilterValues() public méthode

Gets the filter value.
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.
Résultat List

HasFilterControl() public méthode

Determines whether this filter has a filter control
public HasFilterControl ( ) : bool
Résultat bool

IsValid() public méthode

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 The value.
required bool if set to true [required].
message string The message.
Résultat bool

PropertyFilterExpression() public méthode

Gets a filter expression for an entity property value.
public PropertyFilterExpression ( ConfigurationValue>.Dictionary configurationValues, List filterValues, Expression parameterExpression, string propertyName, Type propertyType ) : Expression
configurationValues ConfigurationValue>.Dictionary The configuration values.
filterValues List The filter values.
parameterExpression System.Linq.Expressions.Expression The parameter expression.
propertyName string Name of the property.
propertyType System.Type Type of the property.
Résultat System.Linq.Expressions.Expression

SetConfigurationValues() public méthode

Sets the configuration value.
public SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void
controls List
configurationValues ConfigurationValue>.Dictionary
Résultat void

SetEditValue() public méthode

Sets the value.
public SetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void
control System.Web.UI.Control The control.
configurationValues ConfigurationValue>.Dictionary The configuration values.
value string The value.
Résultat void

SetFilterValueValue() public méthode

Sets the filter value value.
public SetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void
control System.Web.UI.Control The control.
configurationValues ConfigurationValue>.Dictionary The configuration values.
value string The value.
Résultat void

SortValue() public méthode

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.
Résultat object

ValueAsFieldType() public méthode

Returns the value using the most appropriate datatype
public ValueAsFieldType ( System parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object
parentControl System The parent control.
value string The value.
configurationValues ConfigurationValue>.Dictionary The configuration values.
Résultat object