Column Class

UniGrid column.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataBoundControl
        System.Web.UI.WebControls.DataBoundControl
          CMS.UIControls.UniGridConfig.AbstractConfiguration
            CMS.UIControls.UniGridConfig.Column

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

Syntax

public class Column : AbstractConfiguration

The Column type exposes the following members.

Constructors

	Name	Description
Public method	Column()	Constructor.
Public method	Column(XElement)	Constructor.

Properties

	Name	Description
Public property	Action	Action of the column.
Public property	AllowExport	Indicates if column can be exported using general export.
Public property	AllowSorting	Indicates whether the column can be used to sort the rows of the UniGrid.
Public property	Caption	Specifies the resource string used as the header for the column. Must begin and end with the $ character. Sample value: "$general.name$"
Public property	CommandArgument	Command argument for the action.
Public property	CssClass	Specifies the name of the CSS class from the stylesheet to be used for the column.
Public property	ExternalSourceName	Name of the column passed as the sourceName parameter of the OnExternalDataBound event handler. Used for implementing custom functionality in the cells of the given column.
Public property	Field	Corresponding grid field.
Public property	Filter	Column filter.
Public property	Href	If a URL is entered here, a link to this URL is generated around the content of the cells in this column. Macros {0}, {1}, ... can be used to access parameters defined by the parameters attribute. Sample value: "~/page.aspx"
Public property	Icon	Name of an image that should be added into the column cells after the loaded data. The image must be located in the folder defined by the ImageDirectoryPath property of the UniGrid. Sample value: "edit.png"
Public property	IsText	Indicates whether the content of the column is of type Text or nText. This is used to generate a special OrderBy clause of the query, so it must be set if sorting is enabled for the column.
Public property	Localize	Indicates whether localization is enabled for strings in the column.
Public property	MaxLength	Maximum length of the text.
Public property	Name	Column name.
Public property	Parameters	Names of the columns used as parameters of the URL generated by the Href attribute. Separated by semicolons.
Public property	Sort	Used to define the column name to be used for sorting if the ##ALL## macro is used in the source attribute.
Public property	Source	Name of the column from the data source of the UniGrid that is used as the source for the content of this column. The special macro ##ALL## can be used to specify all columns.
Public property	Style	The style used for the entire column. Sample value: "padding:10px"
Public property	Tooltip	Column tooltip.
Public property	Visible	Indicates whether the column should be visible.
Public property	Width	Determines the width of the column. Sample values: "20%", "200px"
Public property	Wrap	Indicates whether word wrapping is used in the column.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)