C# Class Rock.Field.FieldType

Inheritance: IFieldType

Mostrar archivo Open project: NewSpring/Rock

Public Methods

Method	Description
AttributeConstantExpression ( string value ) : ConstantExpression	Attributes the constant expression.
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.
ConvertValueToPropertyType ( string value, Type propertyType, bool isNullableType ) : object	Converts the type of the value to property.
EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : Control	Creates the control(s) necessary for prompting user for a new value
FieldType ( ) : System	Initializes a new instance of the Field class.
FilterCompareControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control	Gets the filter compare control with the specified FilterMode
FilterControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required ) : Control	Creates the control needed to filter (query) values using this field type using a FilterMode of AdvancedFilter
FilterControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control	Creates the control needed to filter (query) values using this field type.
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.
FormatFilterValues ( ConfigurationValue>.Dictionary configurationValues, List filterValues ) : string	Formats the filter values.
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.
GetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string	Reads new values entered by the user for the field
GetEqualToCompareValue ( ) : string	Gets the equal to compare value (types that don't support an equalto comparison (i.e. singleselect) should return null
GetFilterCompareValue ( Control control, FilterMode filterMode ) : string	Gets the filter compare value.
GetFilterFormatScript ( ConfigurationValue>.Dictionary configurationValues, string title ) : string	Gets the filter format script. This script must set a javascript variable named 'result' to a friendly string indicating value of filter controls a '$selectedContent' should be used to limit script to currently selected filter fields
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
IsSensitive ( ) : bool	Setting to determine whether the value from this control is sensitive. This is used for determining whether or not the value of this attribute is logged when changed.
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
OnQualifierUpdated ( object sender, EventArgs e ) : void	Called when [qualifier updated].
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.
SetFilterCompareValue ( Control control, string value ) : void	Sets the filter compare value.
SetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void	Sets the filter value value.
SetFilterValues ( Control filterControl, ConfigurationValue>.Dictionary configurationValues, List filterValues ) : void	Sets the filter 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 ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object	Returns the value using the most appropriate datatype

Method Details

AttributeConstantExpression() public method

Attributes the constant expression.

public AttributeConstantExpression ( string value ) : ConstantExpression
value	string	The value.
return	System.Linq.Expressions.ConstantExpression

AttributeFilterExpression() public method

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.
return	System.Linq.Expressions.Expression

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

ConvertValueToPropertyType() public method

Converts the type of the value to property.

public ConvertValueToPropertyType ( string value, Type propertyType, bool isNullableType ) : object
value	string	The value.
propertyType	System.Type	Type of the property.
isNullableType	bool	if set to true [is nullable type].
return	object

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

FieldType() public method

Initializes a new instance of the Field class.

public FieldType ( ) : System
return	System

FilterCompareControl() public method

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.
return	System.Web.UI.Control

FilterControl() public method

Creates the control needed to filter (query) values using this field type using a FilterMode of AdvancedFilter

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

FilterControl() public method

Creates the control needed to filter (query) values using this field type.

public FilterControl ( 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

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	System.Web.UI.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

FormatFilterValues() public method

Formats the filter values.

public FormatFilterValues ( ConfigurationValue>.Dictionary configurationValues, List filterValues ) : string
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
filterValues	List	The filter values.
return	string

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

GetEditValue() public method

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.
return	string

GetEqualToCompareValue() public method

Gets the equal to compare value (types that don't support an equalto comparison (i.e. singleselect) should return null

public GetEqualToCompareValue ( ) : string
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

GetFilterFormatScript() public method

Gets the filter format script.

This script must set a javascript variable named 'result' to a friendly string indicating value of filter controls a '$selectedContent' should be used to limit script to currently selected filter fields

public GetFilterFormatScript ( ConfigurationValue>.Dictionary configurationValues, string title ) : string
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
title	string	The title.
return	string

GetFilterValueValue() public method

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.
return	string

GetFilterValues() public method

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.
return	List

HasFilterControl() public method

Determines whether this filter has a filter control

public HasFilterControl ( ) : bool
return	bool

IsSensitive() public method

Setting to determine whether the value from this control is sensitive. This is used for determining whether or not the value of this attribute is logged when changed.

public IsSensitive ( ) : bool
return	bool

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

OnQualifierUpdated() public method

Called when [qualifier updated].

public OnQualifierUpdated ( object sender, EventArgs e ) : void
sender	object	The sender.
e	System.EventArgs	The instance containing the event data.
return	void

PropertyFilterExpression() public method

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.
return	System.Linq.Expressions.Expression

SetConfigurationValues() public method

Sets the configuration value.

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

SetEditValue() public method

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.
return	void

SetFilterCompareValue() public method

Sets the filter compare value.

public SetFilterCompareValue ( Control control, string value ) : void
control	System.Web.UI.Control	The control.
value	string	The value.
return	void

SetFilterValueValue() public method

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.
return	void

SetFilterValues() public method

Sets the filter value.

public SetFilterValues ( Control filterControl, ConfigurationValue>.Dictionary configurationValues, List filterValues ) : void
filterControl	System.Web.UI.Control	The filter control.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
filterValues	List	The filter values.
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

ValueAsFieldType() public method

Returns the value using the most appropriate datatype

public ValueAsFieldType ( 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