Back to Devexpress

LayoutViewColumn Members

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

latest27.8 KB
Original Source

LayoutViewColumn Members

Represents a column in a Layout View.

Constructors

NameDescription
LayoutViewColumn()Initializes a new instance of the LayoutViewColumn class with default settings.

Properties

NameDescription
AbsoluteIndexGets or sets the column’s position within the View’s column collection. Inherited from GridColumn.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from GridColumn.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from GridColumn.
AccessibleRoleGets or sets the object’s accessible role. Inherited from GridColumn.
AllowHotTrackGets whether column hot-tracking is allowed.
AllowSummaryMenuGets or sets whether all supported summaries or only the Count summary are enabled in the column’s footer context menu. Inherited from GridColumn.
AppearanceCellGets the appearance settings used to paint the column’s data cells. Inherited from GridColumn.
AppearanceHeaderGets the appearance settings used to paint the column header. Inherited from GridColumn.
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. Inherited from GridColumn.
CanShowInCustomizationFormGets a value indicating whether the column’s header can be displayed within the Customization Form. Inherited from GridColumn.
CaptionGets or sets the column’s display caption. Inherited from GridColumn.
ColumnAnnotationAttributesReturns the object that contains current values for all existing Data Annotation Attributes. Inherited from GridColumn.
ColumnEditGets or sets the in-place editor for all data cells that belong to this column. Inherited from GridColumn.
ColumnEditNameGets or sets the name of the column’s editor. Inherited from GridColumn.
ColumnHandleGets or sets the column’s bound data field by its index within the associated data source. Inherited from GridColumn.
ColumnTypeGets the column’s data type. Inherited from GridColumn.
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. Inherited from GridColumn.
CustomizationSearchCaptionThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from GridColumn.
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. Inherited from GridColumn.
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. Inherited from GridColumn.
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. Inherited from GridColumn.
FilterInfoGets or sets the filter condition applied to the column. Inherited from GridColumn.
FilterModeGets or sets how column values are filtered in the auto filter row and in filter dropdown. Inherited from GridColumn.
FixedGets or sets a value specifying whether the column takes part in horizontal View scrolling or is anchored to a View edge. Inherited from GridColumn.
GroupFormatProvides access to the formatting settings for the column’s values which are displayed within group rows. Inherited from GridColumn.
GroupIndexGets or sets the if the grid data are grouped by the given column, and what the group level is. Inherited from GridColumn.
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. Inherited from GridColumn.
ImageGets or sets the image displayed within the field’s caption.
ImageAlignmentGets or sets the alignment of an image within the field’s caption. This member is not supported. Use the LayoutViewField.ImageAlignment property instead.
ImageIndexGets or sets the index of an image in the ColumnView.Images collection that will be displayed within the field’s caption.
ImageOptionsProvides access to settings that allow you to set up raster and vector icons for this GridColumn. Inherited from GridColumn.
ImagesGets an image collection whose images can be displayed within the column’s header. Inherited from GridColumn.
IsLoadingIndicates whether the View that owns the current column is currently being initialized. Inherited from GridColumn.
IsUnboundExpressionValidGets whether the column’s GridColumn.UnboundExpression specifies a valid expression. Inherited from GridColumn.
LayoutViewFieldGets the layout field that corresponds to the current column.
MaxWidthThis property is not supported by the LayoutViewColumn class.
MinWidthThis property is not supported by the LayoutViewColumn class.
MRUFiltersProvides access to the column’s recently used filters. Inherited from GridColumn.
NameGets or sets the column name. Inherited from GridColumn.
OptionsColumnProvides access to the column’s options. Inherited from GridColumn.
OptionsEditFormProvides access to the settings of the editor that corresponds to the current column within an Edit Form. Inherited from GridColumn.
OptionsFieldContains options that control the display of a field’s sort and filter buttons.
OptionsFilterProvides access to the filter options for the current column. Inherited from GridColumn.
ReadOnlyReturns the OptionsColumn.ReadOnly property value. Inherited from GridColumn.
RealColumnEditGets the repository item that actually represents the column’s editor. Inherited from GridColumn.
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. Inherited from GridColumn.
ShowButtonModeGets or sets a value that specifies which column cells display editor buttons. Inherited from GridColumn.
ShowUnboundExpressionMenuGets or sets whether an end-user can open an Expression Editor for the current unbound column, using a context menu. Inherited from GridColumn.
SiteGets or sets the ISite of the Component. Inherited from Component.
SortIndexGets or sets the column’s position among sorted columns. Inherited from GridColumn.
SortModeGets or sets how the column’s data are sorted/grouped. Inherited from GridColumn.
SortOrderGets or sets the column’s sort order. Inherited from GridColumn.
SummaryAllows you to add multiple total summaries for a column. These summaries are displayed within the View Footer. Inherited from GridColumn.
SummaryItemProvides access to the column’s footer summary settings. Inherited from GridColumn.
SummaryTextGets the summary text displayed within the View footer cell located under this column. Inherited from GridColumn.
TagGets or sets the data associated with the column. Inherited from GridColumn.
ToolTipGets or sets a custom tooltip for the current card field. This member is not supported by the LayoutViewColumn class.
UnboundDataTypeAllows you to make the column unbound, and specify the type of data it stores. Inherited from GridColumn.
UnboundDataTypeNameFor internal use. Inherited from GridColumn.
UnboundExpressionGets or sets an expression that the unbound column uses to calculate its cell values. Columns with unbound expressions are non-editable. Inherited from GridColumn.
UnboundTypeSpecifies whether this column is unbound, and if so, the type of data it stores. Inherited from GridColumn.
ViewGets the View which owns the current column.
VisibleGets or sets whether the card field is visible.
VisibleIndexThis property is not supported by the LayoutViewColumn class.
VisibleWidthGets the actual column width. This property is useful in column auto-width mode (see GridOptionsView.ColumnAutoWidth). Inherited from GridColumn.
WidthThis property is not supported by the LayoutViewColumn class.

Methods

NameDescription
BestFit()Resizes the column to the minimum width required to display the column content completely. Inherited from GridColumn.
ClearFilter()Clears filtering applied to the column. Inherited from GridColumn.
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. Inherited from GridColumn.
GetAccessibleName()Returns the object’s name used by accessibility client applications. Inherited from GridColumn.
GetBestWidth()Returns the minimum width that the column can have and still display its contents completely. Inherited from GridColumn.
GetCaption()Returns the actual display caption for the current column. Inherited from GridColumn.
GetDescription()Gets this column’s description, assigned using the [Display(Description = “. . .”)] data attribute. Inherited from GridColumn.
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. Inherited from GridColumn.
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. Inherited from GridColumn.
GetType()Gets the Type of the current instance. Inherited from Object.
Group()Groups data by the values of the current column. Inherited from GridColumn.
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. Inherited from GridColumn.
ToString()Gets the column’s caption. Inherited from GridColumn.
UnGroup()Ungroups data by the values of the current column. Inherited from GridColumn.

Events

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

See Also

LayoutViewColumn Class

DevExpress.XtraGrid.Columns Namespace