C# Class Rock.Field.Types.RatingFieldType

Inheritance: FieldType

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
FilterValueControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control	Gets the filter value control.
FormatValueAsHtml ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed = false ) : string	Formats the value as HTML.
GetFilterFormatScript ( ConfigurationValue>.Dictionary configurationValues, string title ) : string	Gets the filter format script. This script must set a javascript variable named 'result' to a friendly string indicating value of filter controls a '$selectedContent' should be used to limit script to currently selected filter fields
GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string	Gets the filter value value.
SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void	Sets the configuration value.
SetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues, string value ) : void	Sets the filter value value.
SortValue ( System parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object	Returns the value that should be used for sorting, using the most appropriate datatype
ValueAsFieldType ( System parentControl, string value, ConfigurationValue>.Dictionary configurationValues ) : object	Returns the value using the most appropriate datatype

Private Methods

Method	Description
GetMaxRating ( ConfigurationValue>.Dictionary configurationValues ) : int	Gets the maximum rating.

Method Details

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

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

FormatValueAsHtml() public method

Formats the value as HTML.

public FormatValueAsHtml ( Control parentControl, string value, ConfigurationValue>.Dictionary configurationValues, bool condensed = false ) : string
parentControl	System.Web.UI.Control	The parent control.
value	string	The value.
configurationValues	ConfigurationValue>.Dictionary	The configuration values.
condensed	bool	if set to true [condsed].
return	string

GetFilterFormatScript() public method

Gets the filter format script.

This script must set a javascript variable named 'result' to a friendly string indicating value of filter controls a '$selectedContent' should be used to limit script to currently selected filter fields

public GetFilterFormatScript ( ConfigurationValue>.Dictionary configurationValues, string title ) : string
configurationValues	ConfigurationValue>.Dictionary
title	string	The title.
return	string

GetFilterValueValue() public method

Gets the filter value value.

public GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string
control	System.Web.UI.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

SetFilterValueValue() public method

Sets the filter value value.

public SetFilterValueValue ( 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

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

ValueAsFieldType() public method

Returns the value using the most appropriate datatype

public ValueAsFieldType ( 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