C# 클래스 Rock.Reporting.DataFilterComponent

상속: Rock.Extension.Component
파일 보기 프로젝트 열기: NewSpring/Rock

공개 메소드들

메소드 설명
CreateChildControls ( Type entityType, FilterField filterControl ) : System.Web.UI.Control[]

Creates the model representation of the child controls used to display and edit the filter settings. Implement this version of CreateChildControls if your DataFilterComponent works the same in all filter modes

CreateChildControls ( Type entityType, FilterField filterControl, FilterMode filterMode ) : System.Web.UI.Control[]

Creates the model representation of the child controls used to display and edit the filter settings. Implement this version of CreateChildControls if your DataFilterComponent supports different FilterModes

FormatSelection ( Type entityType, string selection ) : string

Provides a user-friendly description of the specified filter values.

GetClientFormatSelection ( Type entityType ) : string

Formats the selection on the client-side. When the filter is collapsed by the user, the Filterfield control will set the description of the filter to whatever is returned by this property. If including script, the controls parent container can be referenced through a '$content' variable that is set by the control before referencing this property.

GetExpression ( Type entityType, IService serviceInstance, System.Linq.Expressions.ParameterExpression parameterExpression, string selection ) : Expression

Creates a Linq Expression that can be applied to an IQueryable to filter the result set.

GetSelection ( Type entityType, Control controls ) : string

Gets the selection. Implement this version of GetSelection if your DataFilterComponent works the same in all FilterModes

GetSelection ( Type entityType, Control controls, FilterMode filterMode ) : string

Gets a formatted string representing the current filter control values. Implement this version of GetSelection if your DataFilterComponent supports different FilterModes

GetTitle ( Type entityType ) : string

Gets the user-friendly title used to identify the filter component.

RegisterFilterCompareChangeScript ( FilterField filterControl ) : void

Registers Javascript to hide/show .js-filter-control child elements of a .js-filter-compare dropdown see RockWeb\Scripts\Rock\reportingInclude.js

RenderControls ( Type entityType, FilterField filterControl, System.Web.UI.HtmlTextWriter writer, Control controls ) : void

Renders the child controls used to display and edit the filter settings for HTML presentation. Implement this version of RenderControls if your DataFilterComponent works the same in all FilterModes

RenderControls ( Type entityType, FilterField filterControl, System.Web.UI.HtmlTextWriter writer, Control controls, FilterMode filterMode ) : void

Renders the child controls used to display and edit the filter settings for HTML presentation. Implement this version of RenderControls if your DataFilterComponent supports different FilterModes

SetSelection ( Type entityType, Control controls, string selection ) : void

Sets the selection. Implement this version of SetSelection if your DataFilterComponent works the same in all FilterModes

SetSelection ( Type entityType, Control controls, string selection, FilterMode filterMode ) : void

Sets the filter control values from a formatted string. Implement this version of SetSelection if your DataFilterComponent supports different FilterModes

메소드 상세

CreateChildControls() 공개 메소드

Creates the model representation of the child controls used to display and edit the filter settings. Implement this version of CreateChildControls if your DataFilterComponent works the same in all filter modes
public CreateChildControls ( Type entityType, FilterField filterControl ) : System.Web.UI.Control[]
entityType System.Type The System Type of the entity to which the filter will be applied.
filterControl Rock.Web.UI.Controls.FilterField The control that serves as the container for the filter controls.
리턴 System.Web.UI.Control[]

CreateChildControls() 공개 메소드

Creates the model representation of the child controls used to display and edit the filter settings. Implement this version of CreateChildControls if your DataFilterComponent supports different FilterModes
public CreateChildControls ( Type entityType, FilterField filterControl, FilterMode filterMode ) : System.Web.UI.Control[]
entityType System.Type
filterControl Rock.Web.UI.Controls.FilterField
filterMode FilterMode
리턴 System.Web.UI.Control[]

FormatSelection() 공개 메소드

Provides a user-friendly description of the specified filter values.
public FormatSelection ( Type entityType, string selection ) : string
entityType System.Type The System Type of the entity to which the filter will be applied.
selection string A formatted string representing the filter settings.
리턴 string

GetClientFormatSelection() 공개 메소드

Formats the selection on the client-side. When the filter is collapsed by the user, the Filterfield control will set the description of the filter to whatever is returned by this property. If including script, the controls parent container can be referenced through a '$content' variable that is set by the control before referencing this property.
public GetClientFormatSelection ( Type entityType ) : string
entityType System.Type The System Type of the entity to which the filter will be applied.
리턴 string

GetExpression() 공개 추상적인 메소드

Creates a Linq Expression that can be applied to an IQueryable to filter the result set.
public abstract GetExpression ( Type entityType, IService serviceInstance, System.Linq.Expressions.ParameterExpression parameterExpression, string selection ) : Expression
entityType System.Type The type of entity in the result set.
serviceInstance IService A service instance that can be queried to obtain the result set.
parameterExpression System.Linq.Expressions.ParameterExpression The input parameter that will be injected into the filter expression.
selection string A formatted string representing the filter settings.
리턴 System.Linq.Expressions.Expression

GetSelection() 공개 메소드

Gets the selection. Implement this version of GetSelection if your DataFilterComponent works the same in all FilterModes
public GetSelection ( Type entityType, Control controls ) : string
entityType System.Type The System Type of the entity to which the filter will be applied.
controls System.Web.UI.Control The collection of controls used to set the filter values.
리턴 string

GetSelection() 공개 메소드

Gets a formatted string representing the current filter control values. Implement this version of GetSelection if your DataFilterComponent supports different FilterModes
public GetSelection ( Type entityType, Control controls, FilterMode filterMode ) : string
entityType System.Type Type of the entity.
controls System.Web.UI.Control The controls.
filterMode FilterMode The filter mode.
리턴 string

GetTitle() 공개 추상적인 메소드

Gets the user-friendly title used to identify the filter component.
public abstract GetTitle ( Type entityType ) : string
entityType System.Type The System Type of the entity to which the filter will be applied.
리턴 string

RegisterFilterCompareChangeScript() 공개 메소드

Registers Javascript to hide/show .js-filter-control child elements of a .js-filter-compare dropdown see RockWeb\Scripts\Rock\reportingInclude.js
public RegisterFilterCompareChangeScript ( FilterField filterControl ) : void
filterControl Rock.Web.UI.Controls.FilterField The control that serves as the container for the filter controls.
리턴 void

RenderControls() 공개 메소드

Renders the child controls used to display and edit the filter settings for HTML presentation. Implement this version of RenderControls if your DataFilterComponent works the same in all FilterModes
public RenderControls ( Type entityType, FilterField filterControl, System.Web.UI.HtmlTextWriter writer, Control controls ) : void
entityType System.Type The System Type of the entity to which the filter will be applied.
filterControl Rock.Web.UI.Controls.FilterField The control that serves as the container for the controls being rendered.
writer System.Web.UI.HtmlTextWriter The writer being used to generate the HTML for the output page.
controls System.Web.UI.Control The model representation of the child controls for this component.
리턴 void

RenderControls() 공개 메소드

Renders the child controls used to display and edit the filter settings for HTML presentation. Implement this version of RenderControls if your DataFilterComponent supports different FilterModes
public RenderControls ( Type entityType, FilterField filterControl, System.Web.UI.HtmlTextWriter writer, Control controls, FilterMode filterMode ) : void
entityType System.Type Type of the entity.
filterControl Rock.Web.UI.Controls.FilterField The filter control.
writer System.Web.UI.HtmlTextWriter The writer.
controls System.Web.UI.Control The controls.
filterMode FilterMode The filter mode.
리턴 void

SetSelection() 공개 메소드

Sets the selection. Implement this version of SetSelection if your DataFilterComponent works the same in all FilterModes
public SetSelection ( Type entityType, Control controls, string selection ) : void
entityType System.Type Type of the entity.
controls System.Web.UI.Control The controls.
selection string The selection.
리턴 void

SetSelection() 공개 메소드

Sets the filter control values from a formatted string. Implement this version of SetSelection if your DataFilterComponent supports different FilterModes
public SetSelection ( Type entityType, Control controls, string selection, FilterMode filterMode ) : void
entityType System.Type The System Type of the entity to which the filter will be applied.
controls System.Web.UI.Control The collection of controls used to set the filter values.
selection string A formatted string representing the filter settings.
filterMode FilterMode The filter mode.
리턴 void