Back to Devexpress

GridColumn Members

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-gridcolumn-dot-underscore-members.md

latest22.0 KB
Original Source

GridColumn Members

Represents an individual column in Grid Views and Card Views.

Constructors

NameDescription
GridColumn()Creates a new GridColumn object with default settings.

Properties

NameDescription
AbsoluteIndexGets or sets the column’s position within the View’s column collection.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications.
AccessibleNameGets or sets the object’s name used by accessibility client applications.
AccessibleRoleGets or sets the object’s accessible role.
AllowSummaryMenuGets or sets whether all supported summaries or only the Count summary are enabled in the column’s footer context menu.
AppearanceCellGets the appearance settings used to paint the column’s data cells.
AppearanceHeaderGets the appearance settings used to paint the column header.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CanShowInAdvancedCustomizationFormGets whether the column can be shown in the advanced customization form.
CanShowInCustomizationFormGets a value indicating whether the column’s header can be displayed within the Customization Form.
CaptionGets or sets the column’s display caption.
ColumnAnnotationAttributesReturns the object that contains current values for all existing Data Annotation Attributes.
ColumnEditGets or sets the in-place editor for all data cells that belong to this column.
ColumnEditNameGets or sets the name of the column’s editor.
ColumnHandleGets or sets the column’s bound data field by its index within the associated data source.
ColumnTypeGets the column’s data type.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomizationCaptionGets or sets the column’s caption when its header is displayed within the Customization Form.
CustomizationSearchCaptionThis member supports the internal infrastructure, and is not intended to be used directly from your code.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFormatProvides access to the object specifying the formatting applied to column values.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FieldNameTo 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.
FieldNameSortGroupGets 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.
FilterInfoGets or sets the filter condition applied to the column.
FilterModeGets or sets how column values are filtered in the auto filter row and in filter dropdown.
FixedGets or sets a value specifying whether the column takes part in horizontal View scrolling or is anchored to a View edge.
GroupFormatProvides access to the formatting settings for the column’s values which are displayed within group rows.
GroupIndexGets or sets the if the grid data are grouped by the given column, and what the group level is.
GroupIntervalGets 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.
ImageUse settings of the GridColumn.ImageOptions property to get or set a column header image.
ImageAlignmentUse the Alignment setting of the GridColumn.ImageOptions property to get or set column header image alignment.
ImageIndexUse the ImageIndex setting of the GridColumn.ImageOptions property to assign a column header image by its index in an image collection.
ImageOptionsProvides access to settings that allow you to set up raster and vector icons for this GridColumn.
ImagesGets an image collection whose images can be displayed within the column’s header.
IsLoadingIndicates whether the View that owns the current column is currently being initialized.
IsUnboundExpressionValidGets whether the column’s GridColumn.UnboundExpression specifies a valid expression.
MaxWidthGets or sets the column’s maximum width.
MinWidthGets or sets the column’s minimum allowed width.
MRUFiltersProvides access to the column’s recently used filters.
NameGets or sets the column name.
OptionsColumnProvides access to the column’s options.
OptionsEditFormProvides access to the settings of the editor that corresponds to the current column within an Edit Form.
OptionsFilterProvides access to the filter options for the current column.
ReadOnlyReturns the OptionsColumn.ReadOnly property value.
RealColumnEditGets the repository item that actually represents the column’s editor.
SearchTextGets or sets the text of the column’s built-in header search box. This property is supported in Grid Views and Banded Grid Views.
ShowButtonModeGets or sets a value that specifies which column cells display editor buttons.
ShowUnboundExpressionMenuGets or sets whether an end-user can open an Expression Editor for the current unbound column, using a context menu.
SiteGets or sets the ISite of the Component. Inherited from Component.
SortIndexGets or sets the column’s position among sorted columns.
SortModeGets or sets how the column’s data are sorted/grouped.
SortOrderGets or sets the column’s sort order.
SummaryAllows you to add multiple total summaries for a column. These summaries are displayed within the View Footer.
SummaryItemProvides access to the column’s footer summary settings.
SummaryTextGets the summary text displayed within the View footer cell located under this column.
TagGets or sets the data associated with the column.
ToolTipGets or sets a column hint.
UnboundDataTypeAllows you to make the column unbound, and specify the type of data it stores.
UnboundDataTypeNameFor internal use.
UnboundExpressionGets or sets an expression that the unbound column uses to calculate its cell values. Columns with unbound expressions are non-editable.
UnboundTypeSpecifies whether this column is unbound, and if so, the type of data it stores.
ViewGets the View that owns the column.
VisibleGets or sets whether the grid column is visible.
VisibleIndexGets or sets the column’s position within the View’s column header panel.
VisibleWidthGets the actual column width. This property is useful in column auto-width mode (see GridOptionsView.ColumnAutoWidth).
WidthGets or sets the column width.

Methods

NameDescription
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, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetAccessibleDescription()Returns the object’s description used by accessibility client applications.
GetAccessibleName()Returns the object’s name used by accessibility client applications.
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) protectedReturns 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines 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

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

GridColumn Class

DevExpress.XtraGrid.Columns Namespace