DataGridViewColumn

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• DataGridViewElement
  • DataGridViewBand
    • DataGridViewColumn

Represents a column in a DataGridView control.

C#

public class DataGridViewColumn : DataGridViewBand, IWisejComponent, IWisejSerializable, IComponent, IHasResponsiveProfiles

VB.NET

Public Class DataGridViewColumn
    Inherits DataGridViewBand
    Implements IWisejComponent, IWisejSerializable, IComponent, IHasResponsiveProfiles

Constructors

DataGridViewColumn()

Initializes a new instance of the DataGridViewColumn class to the default state.

DataGridViewColumn(cellTemplate)

Initializes a new instance of the DataGridViewColumn class using an existing DataGridViewCell as a template.

Name	Type	Description
cellTemplate	DataGridViewCell	An existing DataGridViewCell to use as a template.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the column can display HTML text. (Default: False)

When AllowHtml is set to true, the text in the cell can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".

AllowMarkdown

Boolean: Returns or sets a value indicating that the column can display markdown text. (Default: False)

AutoEllipsis

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the header text denoting that the text extends beyond the size of the header. (Default: False)

AutoSizeMode

DataGridViewAutoSizeColumnMode: Gets or sets the mode by which the column automatically adjusts its width. (Default: NotSet)

Throws:

• InvalidOperationException The specified value when setting this property results in an InheritedAutoSizeMode value of ColumnHeader for a visible column when column headers are hidden; or the specified value when setting this property results in an InheritedAutoSizeMode value of Fill for a visible column that is frozen.

CellRenderer

String: Returns or sets 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".

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

CellTemplate

DataGridViewCell: Returns or sets the template used to create new cells.

Throws:

• InvalidOperationException The type is null.

CellType

Type: Returns the run-time type of the cell template.

CommandPropertyName

String: Returns or sets the name of the data source property or database column to which the Command is bound. (Default: "")

ContextMenu

ContextMenu: Gets or sets the context menu for the column. (Default: null)

DataGridView

DataGridView: Returns the DataGridView control associated with this element.

DataPropertyName

String: Returns or sets the name of the data source property or database column to which the DataGridViewColumn is bound. (Default: "")

DefaultCellStyle

DataGridViewCellStyle: Returns or sets the column's default cell style.

DefaultMinimumSize

Int32: Returns the default minimum width saving an entry in the property store.

DefaultSize

Int32: Returns the default width saving an entry in the property store.

DisplayIndex

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

Throws:

• ArgumentOutOfRangeException DataGridView is not null and the specified value when setting this property is less than 0 or greater than or equal to the number of columns in the control; or DataGridView is null and the specified value when setting this property is less than -1; or the specified value when setting this property is equal to MaxValue.

Editor

Control: Returns or sets the editor component used to edit cells in this column.

FillWeight

Single: Returns or sets a value that represents the width of the column when it is in fill mode relative to the widths of other fill-mode columns in the control. (Default: 100)

Throws:

• ArgumentOutOfRangeException The specified value when setting this property is less than or equal to 0.

Frozen

Boolean: Returns or sets whether a column will move when a user scrolls the DataGridView control horizontally. (Default: False)

HasResponsiveProfiles

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

HeaderCell

DataGridViewColumnHeaderCell: Returns or sets the DataGridViewColumnHeaderCell that represents the column header.

HeaderImage

Image: Returns or sets the image that is displayed in a column header.

HeaderImageSource

String: Returns or sets the theme name or URL for the image to display in the column header.

HeaderStyle

DataGridViewCellStyle: Returns or sets the column's header style.

HeaderText

String: Returns or sets the caption text on the column's header cell.

InheritedAutoSizeMode

DataGridViewAutoSizeColumnMode: Returns the sizing mode in effect for the column.

InheritedSortMode

DataGridViewColumnSortMode: Returns the sort mode in effect for the column.

IsDataBound

Boolean: Gets a value indicating whether the column is bound to a data source.

IsRow

Boolean: Returns true when the implementation class is DataGridViewRow.

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: 10)

Throws:

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

Movable

DataGridViewTriState: Returns or sets whether the user can move the column.

Setting this property to NotSet inherits the value of AllowUserToOrderColumns. Otherwise the value of this property overrides the behavior determined in AllowUserToOrderColumns.

Name

String: Returns or sets the name of the column.

ReadOnly

Boolean: Returns or sets whether the user can edit the column's cells. (Default: False)

Throws:

• InvalidOperationException This property is set to false for a column that is bound to a read-only data source.

Resizable

DataGridViewTriState: Returns or sets whether the column is resizable.

Selected

Boolean: Returns or sets whether the column is selected.

ShowInVisibilityMenu

Boolean: Returns or sets whether the column should be included in the visibility menu. (Default: True)

Sortable

Boolean: Returns whether the column can be sorted automatically.

SortMode

DataGridViewColumnSortMode: Returns or sets the sort mode for the column. (Default: NotSet)

ToolTipText

String: Returns or sets the text used for ToolTips. (Default: "")

UserPaint

Boolean: Enables or disables the user paint feature for all the cells in this column. When UserPaint is true, the application can handle the CellPaint event to draw custom content in each cell. (Default: False)

ValueType

Type: Returns or sets the data type of the values in the column's cells.

Visible

Boolean: Returns or sets whether the column is visible. (Default: True)

Width

Int32: Returns or sets the current width of the column.

Throws:

• ArgumentOutOfRangeException The specified value when setting this property is greater than 65536.

Methods

Clone()

Returns: Object. An Object that represents the cloned DataGridViewColumn.

Dispose(disposing)

Disposes of the resources used by the DataGridViewColumn and removes from the parent data grid view.

Parameter	Type	Description
disposing	Boolean

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.

OnDataGridViewChanged()

Called when the element is associated with a different DataGridView.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

ResetWidth()

Resets the width to the default value.

Update()

Updates the component on the client.

Events

Disposed

EventHandler Fired when the DataGridViewColumn is disposed.

Inherited By

Name	Description
DataGridViewButtonColumn	Represents a DataGridView column that contains a collection of DataGridViewButtonCell cells.
DataGridViewCheckBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewCheckBoxCell cells.
DataGridViewComboBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewComboBoxCell cells.
DataGridViewDateTimePickerColumn	Represents a DataGridView column that contains a collection of DataGridViewDateTimePickerCell cells.
DataGridViewImageColumn	Represents a DataGridView column that contains a collection of DataGridViewImageCell cells.
DataGridViewLinkColumn	Represents a DataGridView column that contains a collection of DataGridViewLinkCell cells.
DataGridViewMaskedTextBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewTextBoxCell cells.
DataGridViewNumericUpDownColumn	Represents a DataGridView column that contains a collection of DataGridViewNumericUpDownCell cells.
DataGridViewTextBoxColumn	Represents a DataGridView column that contains a collection of DataGridViewTextBoxCell cells.

Implements

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