C# Class Rock.Field.Types.DefinedTypeFieldType

Field Type used to display a dropdown list of Defined Types Stored as DefinedType.Guid
Inheritance: Rock.Web.Cache.FieldType, IEntityFieldType
Show file Open project: NewSpring/Rock

Public Methods

Method Description
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 ( 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.

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

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

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

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

GetEditValueAsEntityId() public method

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?

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 Rock.Data.RockContext The rock context.
return IEntity

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