C# Class Rock.Field.Types.GroupRoleFieldType

Field Type to select a single (or null) group role filtered by a selected group type

Inheritance: FieldType, IEntityFieldType

Public Methods

Method	Description
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
FormatValue ( Control 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 ( as Guid )
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.
SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void	Sets the configuration value.
SetEditValue ( System control, ConfigurationValue>.Dictionary configurationValues, string value ) : void	Sets the value. ( as Guid )
SetEditValueFromEntityId ( Control control, ConfigurationValue>.Dictionary configurationValues, int id ) : void	Sets the edit value from IEntity.Id value

Creates the HTML controls required to configure this type of field

public ConfigurationControls ( ) : List
return	List

Returns a list of the configuration keys

public ConfigurationKeys ( ) : List
return	List

Gets the configuration value.

public ConfigurationValues ( List controls ) : ConfigurationValue>.Dictionary
controls	List	The controls.
return	ConfigurationValue>.Dictionary

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

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

Reads new values entered by the user for the field ( as Guid )

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

Gets the edit value as the IEntity.Id

public GetEditValueAsEntityId ( Control control, ConfigurationValue>.Dictionary configurationValues ) : int?
control	System.Web.UI.Control	The control.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
return	int?

Gets the entity.

public GetEntity ( string value ) : IEntity
value	string	The value.
return	IEntity

Gets the entity.

public GetEntity ( string value, RockContext rockContext ) : IEntity
value	string	The value.
rockContext	Rock.Data.RockContext	The rock context.
return	IEntity

Sets the configuration value.

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

Sets the value. ( as Guid )

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

Sets the edit value from IEntity.Id value

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