C# Class Rock.Field.Types.PageReferenceFieldType

Inheritance: FieldType
Mostrar archivo Open project: NewSpring/Rock Class Usage Examples

Public Methods

Method Description
EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : System.Web.UI.Control

Creates the control(s) necessary for prompting user for a new value

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

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

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 with Page.Guid,PageRoute.Guid or just Page.Guid

HasFilterControl ( ) : bool

Determines whether this filter has a filter control

SetEditValue ( System control, ConfigurationValue>.Dictionary configurationValues, string value ) : void

Sets the value ( as either Page.Guid,PageRoute.Guid or just Page.Guid if not specific to a route )

Method Details

EditControl() public method

Creates the control(s) necessary for prompting user for a new value
public EditControl ( ConfigurationValue>.Dictionary configurationValues, string id ) : System.Web.UI.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 ) : System.Web.UI.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 ( 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 with Page.Guid,PageRoute.Guid or just Page.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

HasFilterControl() public method

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

SetEditValue() public method

Sets the value ( as either Page.Guid,PageRoute.Guid or just Page.Guid if not specific to a route )
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