ColumnFilter Class

Column Filter settings.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      CMS.UIControls.UniGridConfig.ColumnFilter

Namespace: CMS.UIControls.UniGridConfig
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class ColumnFilter : Component

The ColumnFilter type exposes the following members.

Constructors

	Name	Description
Public method	ColumnFilter()	Empty constructor.
Public method	ColumnFilter(XmlNode)	Constructor.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ControlName	Form control name
Public property	CustomFilterParameters	Custom filter parameters.
Public property	DefaultValue	Default value of the filter
Public property	Format	Can be used to define a custom WHERE clause format to be generated by the default filter. The following expressions can be used: {0} - is resolved into the column name {1} - is resolved into the operator selected in the drop-down list of the default filter {2} - is resolved into the value entered into the textbox of the default filter " [{0}] {1} '{2}' "
Public property	Path	Path to the control (.ascx file) that should be used instead of the default filter for the column. If filled, the type attribute is ignored. The default relative path is ~/CMSAdminControls/UI/UniGrid/Filters/.
Public property	Size	Determines the maximum amount of characters that can be entered into the textbox of the default filter. Available for Text, Integer and Double filter types. The default value is 1000.
Public property	Source	Name of the column used in the WHERE clause generated by the filter.
Public property	Type	The filter type that should be created for the given column. Available values: "Text", "Bool", "Integer", "Double".
Public property	Width	Determines the width of the control to customize the default width. (for default filters)