C# Class Rock.Reporting.EntityField

Helper class for saving information about each property and attribute of an entity Note: the type of a field or attribute does not neccesarily determine the ui rendered for filtering. For example, a Single-Select attribute will use a multi-select ui so that user can filter on one or more values. The FilterFieldType property determines the UI rendered for filtering and not the type of field. Entity Property Types and their renderd filter field type string -> TEXT bool or bool? -> SINGLE_SELECT date or date? -> DATE int or int? Defined Values -> MULTI_SELECT otherwise -> INTEGER enumeration -> MULTI_SELECT Attribute types and their rendered filter field type MULTI_SELECT -> MULTI_SELECT SINGLE_SELECT -> MULTI_SELECT BOOLEAN -> SINGLE_SELECT (True or False) DATE -> DATE INTEGER -> INTEGER TEXT -> TEXT

Show file Open project: SparkDevNetwork/Rock Class Usage Examples

Public Methods

Method	Description
EntityField ( string name, FieldKind fieldKind, PropertyInfo propertyInfo ) : System	Initializes a new instance of the EntityField class.
EntityField ( string name, FieldKind fieldKind, Type propertyType, System.Guid attributeGuid, Rock.Web.Cache.FieldTypeCache fieldType ) : System	Initializes a new instance of the EntityField class.
FormattedFilterDescription ( List filterValues ) : string	Formatteds the filter.
GetBoundFieldType ( ) : System.Web.UI.WebControls.BoundField	Gets the type of the bound field.
ToString ( ) : string	Returns a System.String that represents this instance.

Private Methods

Method	Description
EntityField ( string name, FieldKind fieldKind, Type propertyType, PropertyInfo propertyInfo, System.Guid attributeGuid ) : System	Initializes a new instance of the EntityField class.

Method Details

EntityField() public method

Initializes a new instance of the EntityField class.

public EntityField ( string name, FieldKind fieldKind, PropertyInfo propertyInfo ) : System
name	string	The name.
fieldKind	FieldKind	Kind of the field.
propertyInfo	PropertyInfo	The property information.
return	System

EntityField() public method

Initializes a new instance of the EntityField class.

public EntityField ( string name, FieldKind fieldKind, Type propertyType, System.Guid attributeGuid, Rock.Web.Cache.FieldTypeCache fieldType ) : System
name	string	The name.
fieldKind	FieldKind	Kind of the field.
propertyType	System.Type	Type of the property.
attributeGuid	System.Guid	The attribute unique identifier.
fieldType	Rock.Web.Cache.FieldTypeCache	Type of the field.
return	System

FormattedFilterDescription() public method

Formatteds the filter.

public FormattedFilterDescription ( List filterValues ) : string
filterValues	List	The filter values.
return	string

GetBoundFieldType() public method

Gets the type of the bound field.

public GetBoundFieldType ( ) : System.Web.UI.WebControls.BoundField
return	System.Web.UI.WebControls.BoundField

ToString() public method

Returns a System.String that represents this instance.

public ToString ( ) : string
return	string