TreeListColumn Members

Represents a single column in the TreeList control.

Constructors

Name Description
TreeListColumn() Initializes a new TreeListColumn class instance.

Properties

Name Description
AbsoluteIndex Gets or sets a column's position within the Tree List's column collection.
ActualMaxWidth Gets the actual maximum column width.
ActualMinWidth Gets the actual minimum column width.
AllNodesSummary Specifies whether a summary is calculated against all Tree List nodes or against root nodes only.
AllowIncrementalSearch Gets or sets whether incremental searches can be performed against the column.
AppearanceCell Gets the appearance settings used to paint the column's 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.
Caption Gets or sets the column caption displayed in the HeaderPanel of the XtraTreeList.
ColumnAnnotationAttributes Gets data annotation attributes applied to this TreeListColumn.
ColumnEdit Gets or sets the repository item that specifies the editor used to edit a column's cell values.
ColumnEditName Gets or sets the name of the editor used for this column's cells.
ColumnHandle Gets the position of the associated field within the data source.
ColumnIndex Gets the horizontal position of a banded column.
ColumnType Gets the column's data type.
Container Gets the IContainer that contains the Component. Inherited from Component.
CustomizationCaption Gets or sets the column header in the Customization Form.
CustomizationSearchCaption Gets the column caption when its header is displayed in the Customization Form by which it can be found using the Customization Form's search box.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FieldName Gets or sets the field name assigned to the current column from a datasource.
FieldNameSort Gets or sets by what data field this column should sort and filter its data.
FilterInfo Gets an object specifying custom filter criteria.
FilterMode Gets or sets whether to filter data by the displayed text or actual values.
Fixed Gets or sets whether the column is anchored to the control's left or right edge.
Format Gets the object that specifies the formatting applied to column values.
Image Gets or sets the image displayed in the column header.
ImageAlignment Gets or sets the alignment of the column header's image.
ImageIndex Gets or sets the index of the image from the TreeList.ColumnsImageList collection displayed in the column header.
ImageOptions Provides access to settings that allow you to set up raster and vector icons for this TreeListColumn.
Images Gets the source of images that can be displayed within column headers.
IsHierarchical Gets whether this column displays the node expand/collapse buttons.
MaxWidth Gets the maximum column width.
MinWidth Gets the minimum column width.
MRUFilters Provides access to the column's recently used filters.
Name Gets or sets the column's name.
OptionsColumn Provides access to the column's options.
OptionsEditForm Provides access to settings applied to the Edit Form.
OptionsFilter Provides access to the column's filter options.
ParentBand Gets or set a column's parent band.
ReadOnly Gets a value indicating whether data within a column can be edited.
RealColumnEdit Gets the repository item that actually specifies the column's editor.
RowCount Gets or sets the column header height, in logical rows. This property is in effect when columns can be arranged one under another in Banded mode.
RowFooterSummary Specifies the type of summary calculated against child nodes for every parent node in the current column.
RowFooterSummaryStrFormat Gets or sets the format to display the TreeListColumn.RowFooterSummary.
RowIndex Gets or sets the vertical position of a banded column.
SeparatorWidth Gets or sets the width, in pixels, of the column separator (grid vertical lines that visually separate this column from other columns).
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 the index of the column in the sorting columns list.
SortMode Gets or sets how the column's data is sorted when sorting is applied.
SortOrder Gets or sets the column's sort order.
StyleName Gets or sets the name of the style for the current column.
SummaryFooter Specifies the type of the summary to calculate against all nodes.
SummaryFooterStrFormat Gets or sets the format to display the TreeListColumn.SummaryFooter.
Tag Gets or sets the column's associated data.
ToolTip Gets or sets a custom tooltip for the column.
TreeList Obtains the TreeList control to which a column belongs.
UnboundExpression Gets or sets an expression used to evaluate values for the current unbound column.
UnboundType Gets or sets the column's data type and binding mode.
Visible Gets or sets whether the column is visible.
VisibleIndex Gets or sets the position in the Tree List where the current column is displayed.
VisibleWidth Gets the visible width of the column.
Width Gets or sets the column width in pixels.

Methods

Name Description
BestFit() Adjusts the TreeListColumn width to display the contents of the column's cells, header and summaries optimally.
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.
GetCaption() Returns the column's display caption.
GetDescription() Gets this TreeListColumn's description, assigned by a related 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 column's plain text caption.
GetType() Gets the Type of the current instance. Inherited from Object.
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.
ToString() Gets the column's caption.

Events

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