C# Class Rock.Field.Types.BinaryFileFieldType

Field Type used to display a dropdown list of binary files of a specific type Stored as BinaryFile's Guid

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
FilterValueControl ( ConfigurationValue>.Dictionary configurationValues, string id, bool required, FilterMode filterMode ) : Control	Gets the filter value control with the specified FilterMode
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 returns BinaryFile.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.
GetFilterValueValue ( Control control, ConfigurationValue>.Dictionary configurationValues ) : string	Gets the filter value value.
HasFilterControl ( ) : bool	Determines whether this filter has a filter control
SetConfigurationValues ( List controls, ConfigurationValue>.Dictionary configurationValues ) : void	Sets the configuration value.
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

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 with the specified FilterMode

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

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 returns BinaryFile.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
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

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

HasFilterControl() public method

Determines whether this filter has a filter control

public HasFilterControl ( ) : bool
return	bool

SetConfigurationValues() public method

Sets the configuration value.

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

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