GridColumn Members

Represents an individual column in Grid Views and Card Views.

Constructors

Name Description
GridColumn() Creates a new GridColumn object with default settings.

Properties

Name Description
AbsoluteIndex Gets or sets the column's position within the View's column collection.
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.
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 when grouping by the current column is applied. Certain limitations apply in server mode.
Image Gets or sets an image displayed within the Column Header.
ImageAlignment Gets or sets the column header image alignment.
ImageIndex Gets or sets the index of the image displayed within the column header.
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.
ShowButtonMode Gets or sets a value specifying 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.
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 yes, 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.

Methods

Name Description
BestFit() Resizes the column to the minimum width required to display the column content completely.
ClearFilter() Clears filtering applied to the column.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetBestWidth() Returns the minimum width that the column can have and still display its contents completely.
GetCaption() Returns the actual display caption for the current column.
GetDescription() Gets this column's description, assigned using the [Display(Description = ". . .")] data attribute.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetHeaderBestWidth() Returns the column header width that allows the content to be displayed in its entirety.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetTextCaption() Returns the non formatted column caption.
GetType() Gets the Type of the current instance. Inherited from Object.
Group() Groups data by the values of the current column.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Resize(Int32) Specifies a new width for the column.
ToString() Gets the column's caption.
UnGroup() Ungroups data by the values of the current column.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also