Skip to main content
Version: 4.1

ColumnHeader

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

Displays a standard column header in a ListView control.

public class ColumnHeader : Component, ICloneable, IHasPropertyStore, IHasResponsiveProfiles, IImage

Constructors​

Instance member ColumnHeader()​

Initializes a new instance of the ColumnHeader class.

Instance member ColumnHeader(imageIndex)​

Initializes a new instance of the ColumnHeader class with the image specified.

NameTypeDescription
imageIndexInt32The index of the image to display in the ColumnHeader.

Instance member ColumnHeader(imageKey)​

Initializes a new instance of the ColumnHeader class with the image specified.

NameTypeDescription
imageKeyStringThe key of the image to display in the ColumnHeader.

Properties​

Instance member AutoEllipsis​

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the header text when the View property is set to Details. (Default: True)

Value: true to show the ellipsis; otherwise, false. The default is false.

Instance member BackColor​

Color: Returns or sets the background color for the ColumnHeader. (Default: Color [Empty])

The default is Empty to use the current theme's color set in "table-scroller/header/default/properties/backgroundColor".

Instance member CellRenderer​

String: Returns the name of the default cell renderer to use on the client side to render the cells that belong to this column. If it's null or empty it defaults to "Cell". (Default: null)

The name of the cell renderer can be a fully qualified class name (i.e. "wisej.web.datagrid.cellRenderer.Cell") or just the class name (i.e. "ImageCell") in which case the client library prepends "wisej.web.datagrid.cellRenderer".

Instance member ContextMenu​

ContextMenu: Returns or sets the shortcut menu associated with the column header. (Default: null)

Value: A ContextMenu that represents the shortcut menu associated with the column header.

Instance member Control​

Control: Returns or sets a child control to display inside the cell.

Instance member DisplayIndex​

Int32: Returns or sets the display order of the column relative to the currently displayed columns.

Value: The display order of the column, relative to the currently displayed columns.

Throws:

Instance member DisplayPropertyName​

String: Returns or sets the property to display in the Items. (Default: "")

Value: A String specifying the name of an object property that is contained in the collection specified by the DataSource property. The default is an empty string ("").

Instance member ForeColor​

Color: Returns or sets the text color of the ColumnHeader. (Default: Color [Empty])

The default is Empty to use the current theme's color set in "table-scroller/header/default/properties/textColor".

Instance member HasResponsiveProfiles​

Boolean: Check if the component defines any responsive profile without forcing the creation of the collection.

Instance member Image​

Image: Returns or sets the image that is displayed in a ColumnHeader control.

Value: The Image displayed in the header control. The default value is null.

Instance member ImageIndex​

Int32: Returns or sets the index of the image displayed in the ColumnHeader. (Default: -1)

Value: The index of the image displayed in the ColumnHeader.

Throws:

Instance member ImageKey​

String: Returns or sets the key of the image displayed in the ColumnHeader. (Default: "")

Value: The key of the image displayed in the ColumnHeader.

Instance member ImageList​

ImageList: Returns the image list associated with the ColumnHeader.

Value: The ImageList associated with the ColumnHeader.

Instance member ImageSource​

String: Returns or sets the theme name or URL for the image to display in the ColumnHeader control.

Value: The theme name or URL for the image to display in the header control.

Instance member Index​

Int32: Returns the location of this ColumnHeader within the ListView control's ColumnHeaderCollection.

Value: The zero-based index of the column header.

Instance member ListView​

ListView: Returns the ListView control the ColumnHeader is located in.

Value: The ListView control that contains this ColumnHeader.

Instance member MaximumWidth​

Int32: Returns or sets the maximum width, in pixels, of the column. (Default: 32000)

Value: The number of pixels that specifies the maximum width of the column. The default is 32000.

Throws:

Instance member MinimumWidth​

Int32: Returns or sets the minimum width, in pixels, of the column. (Default: 20)

Value: The number of pixels that specifies the minimum width of the column. The default is 20.

Throws:

Instance member Movable​

Boolean: Returns or sets whether the column header can be moved by the user. (Default: True)

Value: True if the user can move the column header; otherwise false.

Instance member Name​

String: Returns or sets the name of the ColumnHeader.

Value: The name of the column header. The default is an empty string ("").

Instance member Resizable​

Boolean: Returns or sets whether the column header can be resized by the user. (Default: True)

Value: The text displayed in the column header.

Instance member Sortable​

Boolean: Returns or sets whether the column can be sorted by clicking on the header. (Default: True)

Value: True if the user can sort the column; otherwise false.

Instance member SortGlyph​

SortOrder: Returns or sets the type of sort glyph to display in the column header. (Default: None)

Instance member Tag​

Object: Returns or sets an object that contains data to associate with the ColumnHeader. (Default: null)

Value: An Object that contains data to associate with the ColumnHeader.

Instance member Text​

String: Returns or sets the text displayed in the column header. (Default: "")

Value: The text displayed in the column header.

Instance member TextAlign​

HorizontalAlignment: Returns or sets the horizontal alignment of the text displayed in the ColumnHeader. (Default: Left)

Value: One of the HorizontalAlignment values. The default is Left.

Instance member Visible​

Boolean: Returns or sets whether the column is visible when the control is in Details view. (Default: True)

Value: True if the column is visible; otherwise false.

Instance member Width​

Int32: Returns or sets the width of the column. (Default: 60)

Value: The width of the column, in pixels.

Methods​

Instance member AutoResize(headerAutoResize)​

Resizes the width of the column as indicated by the resize style.

ParameterTypeDescription
headerAutoResizeColumnHeaderAutoResizeStyleOne of the ColumnHeaderAutoResizeStyle values.

Instance member Clone()​

Creates an identical copy of the current ColumnHeader that is not attached to any list view control.

Returns: Object. An object representing a copy of this ColumnHeader object.

Protected member Dispose(disposing)​

Disposes this ColumnHeader instance.

ParameterTypeDescription
disposingBooleantrue when this method is called by the application rather than a finalizer.

Protected member OnAddReferences(list)​

Returns a collection of referenced components or collection of components.

ParameterTypeDescription
listIListList of referenced components or collection of components.

Protected member OnWebRender(config)​

Renders the client component.

ParameterTypeDescription
configObjectDynamic configuration object.

Instance member Update()​

Updates the component on the client.

Inherited By​

NameDescription
ImageColumnHeaderDisplays an image column header in a ListView control.

Implements​

NameDescription
IUserDataProvides access to the UserData and Tag properties associated to the component implementing this interface.
IImageProvides access to common image properties across the controls that implement this interface.
IWisejComponentAll wisej components implement this interface.
IWisejSerializableAllows an object to serialize itself.