ColumnHeader
Wisej.Web.ColumnHeader
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Displays a standard column header in a ListView control.
Constructors
ColumnHeader()
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Initializes a new instance of the ColumnHeader class.
ColumnHeader(imageIndex)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Initializes a new instance of the ColumnHeader class with the image specified.
Name | Type | Description |
---|---|---|
imageIndex | The index of the image to display in the ColumnHeader. |
ColumnHeader(imageKey)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Initializes a new instance of the ColumnHeader class with the image specified.
Name | Type | Description |
---|---|---|
imageKey | The key of the image to display in the ColumnHeader. |
Properties
AutoEllipsis
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the cell when the View property is set to Details, denoting that the text extends beyond the size of the cell. (Default: False
)
BackColor
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
ContextMenu: Returns or sets the shortcut menu associated with the column header. (Default: null
)
Control
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Control: Returns or sets a child control to display inside the cell.
DisplayIndex
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
String: Returns or sets the property to display in the Items. (Default: ""
)
ForeColor
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Boolean: Check if the component defines any responsive profile without forcing the creation of the collection.
Image
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Image: Returns or sets the image that is displayed in a ColumnHeader control.
ImageIndex
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
String: Returns or sets the key of the image displayed in the ColumnHeader. (Default: ""
)
ImageList
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
ImageList: Returns the image list associated with the ColumnHeader.
ImageSource
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
String: Returns or sets the theme name or URL for the image to display in the ColumnHeader control.
Index
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Int32: Returns the location of this ColumnHeader within the ListView control's ColumnHeaderCollection.
ListView
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
ListView: Returns the ListView control the ColumnHeader is located in.
MinimumWidth
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Int32: Returns or sets the minimum width, in pixels, of the column. (Default: 20
)
Throws:
ArgumentOutOfRangeException The value is less than 2 or greater than 32000.
Movable
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Boolean: Returns or sets whether the column header can be moved by the user. (Default: True
)
Name
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
String: Returns or sets the name of the ColumnHeader.
Resizable
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Boolean: Returns or sets whether the column header can be resized by the user. (Default: True
)
Sortable
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Boolean: Returns or sets whether the column can be sorted by clicking on the header. (Default: True
)
SortGlyph
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
SortOrder: Returns or sets the type of sort glyph to display in the column header. (Default: None
)
Tag
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Object: Returns or sets an object that contains data to associate with the ColumnHeader. (Default: null
)
Text
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
String: Returns or sets the text displayed in the column header. (Default: ""
)
TextAlign
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
HorizontalAlignment: Returns or sets the horizontal alignment of the text displayed in the ColumnHeader. (Default: Left
)
Visible
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Boolean: Returns or sets whether the column is visible when the control is in Details view. (Default: True
)
Width
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Int32: Returns or sets the width of the column. (Default: 60
)
Methods
AutoResize(headerAutoResize)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
Resizes the width of the column as indicated by the resize style.
Parameter | Type | Description |
---|---|---|
headerAutoResize | One of the ColumnHeaderAutoResizeStyle values. |
Clone()
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3858804530-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1zeuyneJ2f5i3NKcg6us%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia&width=300&dpr=4&quality=100&sign=9d369cee&sv=1)
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.
Inherited By
Name | Description |
---|---|
Displays an image column header in a ListView control. |
Implements
Name | Description |
---|---|
Provides access to common image properties across the controls that implement this interface. | |
All wisej components implement this interface. | |
Allows an object to serialize itself. |
Last updated