ColumnHeader

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • Component
    • ColumnHeader

Displays a standard column header in a ListView control.

C#

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

VB.NET

Public Class ColumnHeader
    Inherits Component
    Implements ICloneable, IHasPropertyStore, IHasResponsiveProfiles, IImage

Constructors

ColumnHeader()

Initializes a new instance of the ColumnHeader class.

ColumnHeader(imageIndex)

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

Name	Type	Description
imageIndex	Int32	The index of the image to display in the ColumnHeader.

ColumnHeader(imageKey)

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

Name	Type	Description
imageKey	String	The key of the image to display in the ColumnHeader.

Properties

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)

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".

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".

ContextMenu

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

Control

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

DisplayIndex

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

Throws:

• ArgumentOutOfRangeException The value is less than 0 or greater than or equal to the value of the ColumnCount property.

DisplayPropertyName

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

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".

HasResponsiveProfiles

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

Image

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

ImageIndex

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

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

ImageKey

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

ImageList

ImageList: Returns the image list associated with the ColumnHeader.

ImageSource

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

Index

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

ListView

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

MaximumWidth

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

Throws:

• ArgumentOutOfRangeException The value is less than 0 or greater than 32000.

MinimumWidth

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

Throws:

• ArgumentOutOfRangeException The value is less than 0 or greater than 32000.

Movable

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

Name

String: Returns or sets the name of the ColumnHeader.

Resizable

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

Sortable

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

SortGlyph

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

Tag

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

Text

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

TextAlign

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

Visible

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

Width

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

Methods

AutoResize(headerAutoResize)

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

Parameter	Type	Description
headerAutoResize	ColumnHeaderAutoResizeStyle	One of the ColumnHeaderAutoResizeStyle values.

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.

Dispose(disposing)

Disposes this ColumnHeader instance.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

OnAddReferences(list)

Returns a collection of referenced components or collection of components.

Parameter	Type	Description
list	IList	List of referenced components or collection of components.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Update()

Updates the component on the client.

Inherited By

Name	Description
ImageColumnHeader	Displays an image column header in a ListView control.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IImage	Provides access to common image properties across the controls that implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.