C# Class Rock.Field.Types.CampusFieldType

Field Type to select a single (or null) CampusFieldType

Inheritance: FieldType

Datei anzeigen Open project: NewSpring/Rock

Public Methods

Method	Description
AttributeFilterExpression ( ConfigurationValue>.Dictionary configurationValues, List filterValues, ParameterExpression parameterExpression ) : Expression	Gets the filters expression.
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	Gets the filter value control.
FormatFilterValueValue ( ConfigurationValue>.Dictionary configurationValues, string value ) : string	Formats the filter value value.
FormatValue ( System parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed ) : string	Returns the field's current value(s)
GetEditValue ( System control, ConfigurationValue>.Dictionary configurationValues ) : string	Reads new values entered by the user for the field returns Campus.Guid as string
GetEditValueAsEntityId ( System 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.
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.
GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string	Gets the filter value value.
SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void	Sets the configuration value.
SetEditValue ( System control, ConfigurationValue>.Dictionary configurationValues, string value ) : void	Sets the value. Expects value as a Campus.Guid as string
SetEditValueFromEntityId ( System control, ConfigurationValue>.Dictionary configurationValues, int id ) : void	Sets the edit value from IEntity.Id 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.

Method Details

AttributeFilterExpression() public method

Gets the filters expression.

public AttributeFilterExpression ( ConfigurationValue>.Dictionary configurationValues, List filterValues, ParameterExpression parameterExpression ) : Expression
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
filterValues	List	The filter values.
parameterExpression	ParameterExpression	The parameter expression.
return	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	Control

FilterValueControl() public method

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.
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>.Dictionary configurationValues, bool condensed ) : string
parentControl	System	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

GetEditValue() public method

Reads new values entered by the user for the field returns Campus.Guid as string

public GetEditValue ( System control, ConfigurationValue>.Dictionary configurationValues ) : string
control	System	Parent control that controls were added to in the CreateEditControl() method
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
return	string

GetEditValueAsEntityId() public method

Gets the edit value as the IEntity.Id

public GetEditValueAsEntityId ( System control, ConfigurationValue>.Dictionary configurationValues ) : int?
control	System	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

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	Control	The control.
filterMode	FilterMode	The filter mode.
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

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. Expects value as a Campus.Guid as string

public SetEditValue ( System control, ConfigurationValue>.Dictionary configurationValues, string value ) : void
control	System	The control.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
value	string	The value.
return	void

SetEditValueFromEntityId() public method

Sets the edit value from IEntity.Id value

public SetEditValueFromEntityId ( System control, ConfigurationValue>.Dictionary configurationValues, int id ) : void
control	System	The control.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
id	int	The identifier.
return	void

SetFilterCompareValue() public method

Sets the filter compare value.

public SetFilterCompareValue ( Control control, string value ) : void
control	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	Control	The control.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
value	string	The value.
return	void