C# Class Rock.Reporting.DataSelectComponent

Inheritance: Rock.Extension.Component

Mostra file Open project: NewSpring/Rock Class Usage Examples

Public Methods

Method	Description
CreateChildControls ( Control parentControl ) : System.Web.UI.Control[]	Creates the child controls.
GetAttributeValueFromSelection ( string attributeKey, string selection ) : string	Gets the attribute value from selection.
GetExpression ( RockContext context, MemberExpression entityIdProperty, string selection ) : Expression	Gets the expression.
GetExpression ( System context, MemberExpression entityIdProperty, string selection ) : Expression	Gets the expression. override this for non-RockContext Expressions
GetGridField ( Type entityType, string selection ) : System.Web.UI.WebControls.DataControlField	Gets the grid field.
GetSelection ( Control controls ) : string	Gets the selection. This is typically a string that contains the values selected with the Controls
GetTitle ( Type entityType ) : string	Gets the title of the DataSelectComponent. Override this property to specify a Title that is different from the ColumnPropertyName.
RenderControls ( Control parentControl, System.Web.UI.HtmlTextWriter writer, Control controls ) : void	Renders the controls.
SetSelection ( Control controls, string selection ) : void	Sets the selection.
SortProperties ( string selection ) : string	Comma-delimited list of the Entity properties that should be used for Sorting. Normally, you should leave this as null which will make it sort on the returned field To disable sorting for this field, return string.Empty;
SortReversed ( string selection ) : bool	Override this and set to true to have this field sort in the opposite direction Normally this should be left as false unless there is a special case where it makes sense have it sort reversed
ToString ( ) : string	Returns a System.String that represents this instance.

Private Methods

Method	Description
GetAttributesSelectionValues ( Control controls ) : string>.Dictionary	Gets the attributes selection values.
SetAttributesSelectionValues ( Control controls, string selection ) : void	Sets the attributes selection values.

Method Details

CreateChildControls() public method

Creates the child controls.

public CreateChildControls ( Control parentControl ) : System.Web.UI.Control[]
parentControl	System.Web.UI.Control
return	System.Web.UI.Control[]

GetAttributeValueFromSelection() public method

Gets the attribute value from selection.

public GetAttributeValueFromSelection ( string attributeKey, string selection ) : string
attributeKey	string	The attribute key.
selection	string	The selection.
return	string

GetExpression() public abstract method

Gets the expression.

public abstract GetExpression ( RockContext context, MemberExpression entityIdProperty, string selection ) : Expression
context	Rock.Data.RockContext	The context.
entityIdProperty	System.Linq.Expressions.MemberExpression	The entity identifier property.
selection	string	The selection.
return	System.Linq.Expressions.Expression

GetExpression() public method

Gets the expression. override this for non-RockContext Expressions

public GetExpression ( System context, MemberExpression entityIdProperty, string selection ) : Expression
context	System	The context.
entityIdProperty	System.Linq.Expressions.MemberExpression	The entity identifier property.
selection	string	The selection.
return	System.Linq.Expressions.Expression

GetGridField() public method

Gets the grid field.

public GetGridField ( Type entityType, string selection ) : System.Web.UI.WebControls.DataControlField
entityType	System.Type	Type of the entity.
selection	string	The selection.
return	System.Web.UI.WebControls.DataControlField

GetSelection() public method

Gets the selection. This is typically a string that contains the values selected with the Controls

public GetSelection ( Control controls ) : string
controls	System.Web.UI.Control	The controls.
return	string

GetTitle() public method

Gets the title of the DataSelectComponent. Override this property to specify a Title that is different from the ColumnPropertyName.

public GetTitle ( Type entityType ) : string
entityType	System.Type
return	string

RenderControls() public method

Renders the controls.

public RenderControls ( Control parentControl, System.Web.UI.HtmlTextWriter writer, Control controls ) : void
parentControl	System.Web.UI.Control	The parent control.
writer	System.Web.UI.HtmlTextWriter	The writer.
controls	System.Web.UI.Control	The controls.
return	void

SetSelection() public method

Sets the selection.

public SetSelection ( Control controls, string selection ) : void
controls	System.Web.UI.Control	The controls.
selection	string	The selection.
return	void

SortProperties() public method

Comma-delimited list of the Entity properties that should be used for Sorting. Normally, you should leave this as null which will make it sort on the returned field To disable sorting for this field, return string.Empty;

public SortProperties ( string selection ) : string
selection	string
return	string

SortReversed() public method

Override this and set to true to have this field sort in the opposite direction Normally this should be left as false unless there is a special case where it makes sense have it sort reversed

public SortReversed ( string selection ) : bool
selection	string	The selection.
return	bool

ToString() public method

Returns a System.String that represents this instance.

public ToString ( ) : string
return	string