DataGridViewCheckBoxCell

Wisej.Web.DataGridViewCheckBoxCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Displays a CheckBox icon (not the actual control) in a DataGridViewCell cell.

public class DataGridViewCheckBoxCell : DataGridViewCell

Constructors

DataGridViewCheckBoxCell()

Initializes a new instance of DataGridViewCheckBoxCell.

Properties

FalseValue

Object: Gets or sets the value that corresponds to false, which appears as an unchecked box. (Default: null)

FormattedValueType

Type: Returns the type of the formatted value associated with the cell.

IndeterminateValue

Object: Gets or sets the value that corresponds to indeterminate, which appears as an indeterminate box. (Default: null)

ThreeState

Boolean: Returns or sets a value indicating if the checkbox cell supports three states. (Default: False)

TrueValue

Object: Gets or sets the value that corresponds to true, which appears as checked box. (Default: null)

ValueType

Type: Returns or sets the data type of the values in the cell.

Methods

GetCellDataValue(cellStyle, includeVisualProperties)

Returns the data value of the cell. This is the value that is returned to the client in the data response stream.

Parameter
Type
Description

cellStyle

The cell style in effect for the current cell, used to format the cell's value for the client rendering.

includeVisualProperties

true to include inherited visual properties; otherwise, false to include only formatting properties.

Returns: Object.

GetFormattedValue(value, cellStyle, valueTypeConverter, formattedTypeConverter)

Returns the value of the cell formatted for the client.

Parameter
Type
Description

value

The value to be formatted.

cellStyle

The DataGridViewCellStyle in for the cell.

valueTypeConverter

A TypeConverter providing custom conversion from the formatted type to the value type, or null if no custom conversion is required.

formattedTypeConverter

A TypeConverter providing custom conversion from the value type to the formatted type, or null if no custom conversion is required.

Returns: Object. The value of the cell or null if the cell does not belong to a DataGridView control.

Throws:

OnClick(e)

Raised when the user clicks on a cell. The DataGridCheckBoxCell class processes this event to determine the location of click and toggles the checkbox accordingly.

Parameter
Type
Description

OnKeyDown(e)

Raised when the user presses a key on the keyboard while the focus is on the table and not in edit mode.

Parameter
Type
Description

ParseFormattedValue(value, cellStyle, formattedTypeConverter, valueTypeConverter)

Converts a value to the actual cell value.

Parameter
Type
Description

value

The display value of the cell.

cellStyle

The DataGridViewCellStyle in effect for the cell.

formattedTypeConverter

A TypeConverter for the display value type, or null to use the default converter.

valueTypeConverter

A TypeConverter for the cell value type, or null to use the default converter.

Returns: Object. The cell value.

Throws:

Implements

Name
Description

Provides access to the UserData and Tag properties associated to the component implementing this interface.

Defines an object that can invoke a Command.

Last updated

Was this helpful?