Column Class |
Namespace: CMS.UIControls.UniGridConfig
public class Column : AbstractConfiguration
The Column type exposes the following members.
Name | Description | |
---|---|---|
Column() |
Constructor.
| |
Column(XElement) |
Constructor.
|
Name | Description | |
---|---|---|
Action |
Action of the column.
| |
AllowExport |
Indicates if column can be exported using general export.
| |
AllowSorting |
Indicates whether the column can be used to sort the rows of the UniGrid.
| |
Caption |
Specifies the resource string used as the header for the column. Must begin and end with the $ character.
Sample value: "$general.name$"
| |
CommandArgument |
Command argument for the action.
| |
CssClass |
Specifies the name of the CSS class from the stylesheet to be used for the column.
| |
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.
| |
Field |
Corresponding grid field.
| |
Filter |
Column filter.
| |
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"
| |
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"
| |
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.
| |
Localize |
Indicates whether localization is enabled for strings in the column.
| |
MaxLength |
Maximum length of the text.
| |
Name |
Column name.
| |
Parameters |
Names of the columns used as parameters of the URL generated by the Href attribute. Separated by semicolons.
| |
Sort |
Used to define the column name to be used for sorting if the ##ALL## macro is used in the source attribute.
| |
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.
| |
Style |
The style used for the entire column.
Sample value: "padding:10px"
| |
Tooltip |
Column tooltip.
| |
Visible |
Indicates whether the column should be visible.
| |
Width |
Determines the width of the column.
Sample values: "20%", "200px"
| |
Wrap |
Indicates whether word wrapping is used in the column.
|
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
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.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) |