C# Class Rock.Field.Types.DefinedValueFieldType

Inheritance: Rock.Web.Cache.FieldType, IEntityFieldType
Mostra file Open project: NewSpring/Rock

Public Methods

Method 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

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.

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

Filters the 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)

GetConfigurationValuesFromEntityQualifier ( string entityTypeQualifierColumn, string entityTypeQualifierValue ) : Rock.Field.ConfigurationValue>.Dictionary

Gets the configuration values for this field using the EntityTypeQualiferColumn and EntityTypeQualifierValues

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

Reads new values entered by the user for the field

GetEditValueAsEntityId ( Control control, ConfigurationValue>.Dictionary configurationValues ) : int?

Gets the edit value as the IEntity.Id

GetEntity ( string value ) : IEntity

Gets the entity.

GetEntity ( string value, RockContext rockContext ) : IEntity

Gets the entity.

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

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.

SetEditValueFromEntityId ( Control control, ConfigurationValue>.Dictionary configurationValues, int id ) : void

Sets the edit value from IEntity.Id value

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

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

Method Details

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

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

FilterValueControl() public method

Filters the 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.
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

FormatValue() public method

Returns the field's current value(s)
public FormatValue ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed ) : string
parentControl 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

GetConfigurationValuesFromEntityQualifier() public method

Gets the configuration values for this field using the EntityTypeQualiferColumn and EntityTypeQualifierValues
public GetConfigurationValuesFromEntityQualifier ( string entityTypeQualifierColumn, string entityTypeQualifierValue ) : Rock.Field.ConfigurationValue>.Dictionary
entityTypeQualifierColumn string The entity type qualifier column.
entityTypeQualifierValue string The entity type qualifier value.
return Rock.Field.ConfigurationValue>.Dictionary

GetEditValue() public method

Reads new values entered by the user for the field
public GetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string
control Control Parent control that controls were added to in the CreateEditControl() method
configurationValues ConfigurationValue>.Dictionary
return string

GetEditValueAsEntityId() public method

Gets the edit value as the IEntity.Id
public GetEditValueAsEntityId ( Control control, ConfigurationValue>.Dictionary configurationValues ) : int?
control Control The control.
configurationValues ConfigurationValue>.Dictionary The configuration values.
return int?

GetEntity() public method

Gets the entity.
public GetEntity ( string value ) : IEntity
value string The value.
return IEntity

GetEntity() public method

Gets the entity.
public GetEntity ( string value, RockContext rockContext ) : IEntity
value string The value.
rockContext RockContext The rock context.
return IEntity

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

GetFilterValueValue() public method

Gets the filter value value.
public GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string
control 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 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

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 Expression The parameter expression.
propertyName string Name of the property.
propertyType Type Type of the property.
return Expression

SetConfigurationValues() public method

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

SetEditValue() public method

Sets the value.
public SetEditValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void
control Control The control.
configurationValues ConfigurationValue>.Dictionary
value string The value.
return void

SetEditValueFromEntityId() public method

Sets the edit value from IEntity.Id value
public SetEditValueFromEntityId ( Control control, ConfigurationValue>.Dictionary configurationValues, int id ) : void
control Control The control.
configurationValues ConfigurationValue>.Dictionary The configuration values.
id int The identifier.
return void

SortValue() public method

Returns the value that should be used for sorting, using the most appropriate datatype
public SortValue ( System parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object
parentControl System The parent control.
value string The value.
configurationValues ConfigurationValue>.Dictionary The configuration values.
return object