GridColumn Properties
Represents an individual column in Grid Views and Card Views.Name | Description |
---|---|
AbsoluteIndex | Gets or sets the column’s position within the View’s column collection. |
AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. |
AccessibleName | Gets or sets the object’s name used by accessibility client applications. |
AccessibleRole | Gets or sets the object’s accessible role. |
AllowSummaryMenu | Gets or sets whether all supported summaries or only the Count summary are enabled in the column’s footer context menu. |
AppearanceCell | Gets the appearance settings used to paint the column’s data cells. |
AppearanceHeader | Gets the appearance settings used to paint the column header. |
CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
CanShowInAdvancedCustomizationForm | Gets whether the column can be shown in the advanced customization form. |
CanShowInCustomizationForm | Gets a value indicating whether the column’s header can be displayed within the Customization Form. |
Caption | Gets or sets the column’s display caption. |
ColumnAnnotationAttributes | Returns the object that contains current values for all existing Data Annotation Attributes. |
ColumnEdit | Gets or sets the in-place editor for all data cells that belong to this column. |
ColumnEditName | Gets or sets the name of the column’s editor. |
ColumnHandle | Gets or sets the column’s bound data field by its index within the associated data source. |
ColumnType | Gets the column’s data type. |
Container | Gets the IContainer that contains the Component. Inherited from Component. |
CustomizationCaption | Gets or sets the column’s caption when its header is displayed within the Customization Form. |
CustomizationSearchCaption | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
DisplayFormat | Provides access to the object specifying the formatting applied to column values. |
Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
FieldName | To bind a column to a data source field, set this property to the required data field name. To create unbound columns, assign a unique identifier to this property. If you obtained a column as a method return value or as an event argument, read the FieldName property value to identify this column. |
FieldNameSortGroup | Gets or sets another field by which data is sorted/grouped/filtered when sorting/grouping/filtering is applied to the current column. The FieldNameSortGroup property is intended to be used in Server data binding modes to sort columns (e.g., lookup columns) against text instead of edit values. |
FilterInfo | Gets or sets the filter condition applied to the column. |
FilterMode | Gets or sets how column values are filtered in the auto filter row and in filter dropdown. |
Fixed | Gets or sets a value specifying whether the column takes part in horizontal View scrolling or is anchored to a View edge. |
GroupFormat | Provides access to the formatting settings for the column’s values which are displayed within group rows. |
GroupIndex | Gets or sets the if the grid data are grouped by the given column, and what the group level is. |
GroupInterval | Gets or sets how data rows are grouped by a specific column. The following help section describes the limitations of server mode: Server Mode Limitations and Specifics. |
Image | Use settings of the GridColumn.ImageOptions property to get or set a column header image. |
ImageAlignment |
Use the Alignment setting of the GridColumn.ImageOptions property to get or set column header image alignment.
|
ImageIndex |
Use the ImageIndex setting of the GridColumn.ImageOptions property to assign a column header image by its index in an image collection.
|
ImageOptions | Provides access to settings that allow you to set up raster and vector icons for this GridColumn. |
Images | Gets an image collection whose images can be displayed within the column’s header. |
IsLoading | Indicates whether the View that owns the current column is currently being initialized. |
IsUnboundExpressionValid | Gets whether the column’s GridColumn.UnboundExpression specifies a valid expression. |
MaxWidth | Gets or sets the column’s maximum width. |
MinWidth | Gets or sets the column’s minimum allowed width. |
MRUFilters | Provides access to the column’s recently used filters. |
Name | Gets or sets the column name. |
OptionsColumn | Provides access to the column’s options. |
OptionsEditForm | Provides access to the settings of the editor that corresponds to the current column within an Edit Form. |
OptionsFilter | Provides access to the filter options for the current column. |
ReadOnly | Returns the OptionsColumn.ReadOnly property value. |
RealColumnEdit | Gets the repository item that actually represents the column’s editor. |
SearchText | Gets or sets the text of the column’s built-in header search box. This property is supported in Grid Views and Banded Grid Views. |
ShowButtonMode | Gets or sets a value that specifies which column cells display editor buttons. |
ShowUnboundExpressionMenu | Gets or sets whether an end-user can open an Expression Editor for the current unbound column, using a context menu. |
Site | Gets or sets the ISite of the Component. Inherited from Component. |
SortIndex | Gets or sets the column’s position among sorted columns. |
SortMode | Gets or sets how the column’s data are sorted/grouped. |
SortOrder | Gets or sets the column’s sort order. |
Summary | Allows you to add multiple total summaries for a column. These summaries are displayed within the View Footer. |
SummaryItem | Provides access to the column’s footer summary settings. |
SummaryText | Gets the summary text displayed within the View footer cell located under this column. |
Tag | Gets or sets the data associated with the column. |
ToolTip | Gets or sets a column hint. |
UnboundDataType | Allows you to make the column unbound, and specify the type of data it stores. |
UnboundDataTypeName | For internal use. |
UnboundExpression | Gets or sets an expression that the unbound column uses to calculate its cell values. Columns with unbound expressions are non-editable. |
UnboundType | Specifies whether this column is unbound, and if so, the type of data it stores. |
View | Gets the View that owns the column. |
Visible | Gets or sets whether the grid column is visible. |
VisibleIndex | Gets or sets the column’s position within the View’s column header panel. |
VisibleWidth | Gets the actual column width. This property is useful in column auto-width mode (see GridOptionsView.ColumnAutoWidth). |
Width | Gets or sets the column width. |
See Also