C# Class Rock.Field.Types.LocationFieldType

Field used to save and display a location value
Inheritance: FieldType, IEntityFieldType
Mostra 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 ( as Guid )

FilterControl ( ConfigurationValue>.System configurationValues, string id, bool required, Rock filterMode ) : Control

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

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

HasFilterControl ( ) : bool

Determines whether this filter has a filter control

SetEditValue ( Control 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

Method Details

EditControl() public method

Creates the control(s) necessary for prompting user for a new value ( as Guid )
public EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : Control
configurationValues ConfigurationValue>.Dictionary The configuration values.
id string
return System.Web.UI.Control

FilterControl() public method

Creates the control needed to filter (query) values using this field type.
public FilterControl ( ConfigurationValue>.System configurationValues, string id, bool required, Rock filterMode ) : Control
configurationValues ConfigurationValue>.System The configuration values.
id string The identifier.
required bool if set to true [required].
filterMode Rock The filter mode.
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 ( as Guid )
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

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

HasFilterControl() public method

Determines whether this filter has a filter control
public HasFilterControl ( ) : bool
return bool

SetEditValue() public method

Sets the value. ( as Guid )
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

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