1 of 100

Lists & Grids

CheckedListBox

Wisej.Web.CheckedListBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Control
- ListControl
  - ListBox
    CheckedListBox

Displays a ListBox in which a check box is displayed to the left of each item.

public class CheckedListBox : ListBox

Public Class CheckedListBox
    Inherits ListBox

Constructors

CheckedListBox()

Initializes a new instance of the CheckedListBox class.

Properties

CheckedIndices

CheckedIndexCollection: Collection of checked indexes in the CheckedListBox.

CheckedObjectCollection: Collection of checked items in the CheckedListBox.

Boolean: Returns or sets whether list items are checked when they are clicked. The default is to check the item when clicking on the checkbox icon. (Default: False)

String: Returns or sets the property to bind to the CheckState of the items in the CheckedListBox control. (Default: "")

ObjectCollection: Returns the collection of items in this CheckedListBox.

Methods

Unchecks all items in the CheckedListBox.

Returns a value indicating whether the specified item is checked.

Returns: Boolean. true if the item is checked; otherwise, false.

Throws:

ArgumentException The index specified is less than zero; or the index specified is greater than or equal to the count of items in the list.

Returns a value indicating the check state of the current item.

Returns: CheckState. One of the CheckState values.

Throws:

ArgumentOutOfRangeException The index specified is less than zero; or the index specified is greater than or equal to the count of items in the list.

Sets CheckState for the item at the specified index to Checked.

Throws:

ArgumentException The index specified is less than zero; or the index is greater than the count of items in the list.

Sets the check state of the item at the specified index.

Throws:

ArgumentOutOfRangeException The index specified is less than zero; or the index is greater than or equal to the count of items in the list.

Events

ItemCheckEventHandler Fired after the checked state of an item changes.

EventHandler Fired when the CheckStateMember property changes.

EventHandler Fired when the user clicks the CheckedListBox control.

ItemCheckEventHandler Fired when the checked state of an item changes.

MouseEventHandler Fired when the user clicks the CheckedListBox control with the mouse.

Implements

CheckedListBox.CheckedIndexCollection

Wisej.Web.CheckedListBox CheckedIndexCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the collection containing the indexes to the selected items in a .

Properties

Count

: Returns the number of selected items.

IsReadOnly

: Returns a value indicating whether this collection can be modified.

Item(index)

: Returns the index of a checked item in the control.

Throws:

The index is less than zero.-or- The index is not in the collection.

Methods

Determines if the specified index is located within the collection.

Copies the entire collection into an existing array at a specified location within the array.

Throws:

Returns an index into the collection of checked indexes.

CheckedListBox.CheckedObjectCollection

Wisej.Web.CheckedListBox CheckedObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the collection of checked items in the .

Properties

Count

: Returns the number of selected items.

IsReadOnly

: Returns a value indicating whether this collection can be modified.

Item(index)

: Return an item in the checked items collection.

Throws:

The object cannot be set.

Methods

Determines if the specified item is located within the collection.

Copies the entire collection into an existing array at a specified location within the array.

Throws:

Returns an index into the collection of checked items.

CheckedListBox.ObjectCollection

Wisej.Web.CheckedListBox ObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

ObjectCollection
- ObjectCollection

Represents the collection of items in a CheckedListBox.

public class ObjectCollection : ObjectCollection

Public Class ObjectCollection
    Inherits ObjectCollection

Methods

Add(item)

Adds an item to the list of items for a ListBox.

Parameter

Type

Description

Returns: Int32. The zero-based index of the item in the collection.

Throws:

ArgumentNullException The item parameter was null.

Add(item, isChecked)

Adds an item to the list of items for a CheckedListBox.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

ArgumentNullException The item parameter was null.

Adds an item to the list of items for a CheckedListBox.

Returns: Int32.

Adds a collection of items to the list.

Removes all items from the CheckedListBox control.

Inserts an item into the collection at the specified index.

Throws:

ArgumentNullException The item was null.
ArgumentOutOfRangeException The index was less than zero; or the index was greater than the count of items in the collection.

Inserts an item into the collection at the specified index.

Throws:

ArgumentNullException The item was null.
ArgumentOutOfRangeException The index was less than zero; or the index was greater than the count of items in the collection.

Removes an item from the ListBox at the specified index.

Throws:

ArgumentOutOfRangeException The index parameter was less than zero, or the index parameter was greater than or equal to the count of items in the collection.

ItemCheckEventArgs

Wisej.Web.ItemCheckEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Provides data for the event of the and controls.

Constructors

ItemCheckEventArgs(index, newCheckValue, currentValue)

Initializes a new instance of the class.

Name

Type

Description

Properties

CurrentValue

: Returns a value indicating the current state of the item's check box.

Index

Used By

ItemCheckEventHandler

Wisej.Web.ItemCheckEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the method that will handle the ItemCheck event of a CheckedListBox or ListView control.

public delegate void ItemCheckEventHandler(Object sender, ItemCheckEventArgs e)

Public Delegate Sub ItemCheckEventHandler(ByVal sender As [Object], ByVal e As ItemCheckEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

ComboBox

Wisej.Web.ComboBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents a combo box control.

Constructors

ComboBox()

Initializes an instance of ComboBox.

Properties

AllowHtml

: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

AutoCompleteMode

Throws:

Methods

Not used. Kept for compatibility.

Copies the current selection in the text box to the Clipboard.

Moves the current selection in the text box to the Clipboard.

Not used. Kept for compatibility.

Finds the first item in the combo box that matches the specified string.

Finds the first item after the specified index that matches the specified string.

Replaces the current selection in the text box with the contents of the Clipboard.

Events

The application may implement a different way to select the item when the user types a text and the ComboBox is validated. Set e.Handled to true to override the standard behavior.

Inherited By

Implements

ComboBox.ObjectCollection

Wisej.Web.ComboBox ObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the collection of items in a Wisej.Web.ComboBox control.

Properties

Count

: Returns the number of items in the collection.

IsReadOnly

: Returns a value indicating whether this collection can be modified.

Item(index)

: Retrieves the item at the specified index within the collection.

Throws:

The index was less than zero; or the index was greater of equal to the count of items in the collection.

Methods

Throws:

Adds a collection of items to the list.

Determines if the specified item is located within the collection.

Throws:

Copies the entire collection into an existing array of objects at a specified location within the array.

Returns an enumerator that can be used to iterate through the item collection.

Retrieves the index within the collection of the specified item.

Throws:

Inserts an item into the collection at the specified index.

Throws:

Events

BaseCollection

Wisej.Web.BaseCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Provides the base functionality for creating data-related collections in the control.

Constructors

BaseCollection()

Initializes a new instance of the class.

Inherited By

Name

Description

CheckedListBox

Wisej.Web.CheckedListBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Control
- ListControl
  - ListBox
    CheckedListBox

Displays a ListBox in which a check box is displayed to the left of each item.

public class CheckedListBox : ListBox

Public Class CheckedListBox
    Inherits ListBox

Constructors

CheckedListBox()

Initializes a new instance of the CheckedListBox class.

Properties

CheckedIndices

CheckedIndexCollection: Collection of checked indexes in the CheckedListBox.

CheckedItems

CheckedObjectCollection: Collection of checked items in the CheckedListBox.

CheckOnClick

Boolean: Returns or sets whether list items are checked when they are clicked. The default is to check the item when clicking on the checkbox icon. (Default: False)

CheckStateMember

String: Returns or sets the property to bind to the CheckState of the items in the CheckedListBox control. (Default: "")

Items

ObjectCollection: Returns the collection of items in this CheckedListBox.

Methods

ClearChecked()

Unchecks all items in the CheckedListBox.

GetItemChecked(index)

Returns a value indicating whether the specified item is checked.

Parameter

Type

Description

Returns: Boolean. true if the item is checked; otherwise, false.

Throws:

ArgumentException The index specified is less than zero; or the index specified is greater than or equal to the count of items in the list.

GetItemCheckState(index)

Returns a value indicating the check state of the current item.

Parameter

Type

Description

Returns: CheckState. One of the CheckState values.

Throws:

ArgumentOutOfRangeException The index specified is less than zero; or the index specified is greater than or equal to the count of items in the list.

SetItemChecked(index, value)

Sets CheckState for the item at the specified index to Checked.

Parameter

Type

Description

Throws:

ArgumentException The index specified is less than zero; or the index is greater than the count of items in the list.

SetItemCheckState(index, value)

Sets the check state of the item at the specified index.

Parameter

Type

Description

Throws:

ArgumentOutOfRangeException The index specified is less than zero; or the index is greater than or equal to the count of items in the list.

Events

AfterItemCheck

ItemCheckEventHandler Fired after the checked state of an item changes.

CheckStateMemberChanged

EventHandler Fired when the CheckStateMember property changes.

Click

EventHandler Fired when the user clicks the CheckedListBox control.

ItemCheck

ItemCheckEventHandler Fired when the checked state of an item changes.

MouseClick

MouseEventHandler Fired when the user clicks the CheckedListBox control with the mouse.

Implements

Name

Description

ComboBox

Wisej.Web.ComboBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents a combo box control.

Constructors

ComboBox()

Initializes an instance of ComboBox.

Properties

AllowHtml

: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

AutoCompleteMode

: Returns or sets how automatic completion works for the . (Default: None)

AutoSize

: Returns or sets whether the height of the control is set automatically. (Default: True)

CharacterCasing

: Returns or sets whether the control modifies the case of characters as they are typed. (Default: Normal)

DropDownHeight

: Returns or sets the maximum height in pixels of the drop-down portion of the . (Default: 400)

Throws:

The specified value is less than one.

DropDownStyle

: Returns or sets the drop down style of the combo box. (Default: DropDown)

DropDownWidth

: Returns or sets the maximum width in pixels of the drop-down list of the . When the value is 0, the drop-down list will grow to fit the largest item. (Default: 0)

Throws:

The specified value is less than one.

DroppedDown

: Returns or sets whether the combo box is displaying its drop-down portion.

EnableNativeContextMenu

: Enables or disables the browser's context menu. (Default: True)

IncrementalSelection

: Returns or sets whether items are selected incrementally as the user types within a timeout of 1 second. (Default: True)

ItemHeight

: Gets or sets the height of the list items in the drop-down list. When the value is -1, uses the value set in the theme. (Default: -1)

Throws:

The assigned value is less than -1; or the assigned value is greater than 500.

Items

: Returns the collection of the items contained in this .

Label

: Provides a label related to the control.

LabelText

: Returns or sets the localizable label associated with this control. (Default: "")

LazyLoading

: Returns or sets whether the items are sent to the client the first time the list is opened and enables the event. (Default: False)

MaxLength

: Returns or sets the number of characters a user can type into the . (Default: 0)

Throws:

The value is less than 0.

ReadOnly

: Returns or sets whether the control is read-only. (Default: False)

SelectedIndex

: Returns or sets the index of the currently selected item.

Throws:

The specified index is less than -1; o the specified index is greater than the number of items in the combo box.

SelectedItem

: Returns or sets currently selected item in the .

SelectedText

: Returns or sets the text that is selected in the editable portion of a .

SelectionLength

: Returns or sets the number of characters selected in the editable portion of the combo box.

Throws:

The value was less than zero.

SelectionStart

: Returns or sets the starting index of text selected in the combo box.

Throws:

The value is less than zero.

Sorted

: Returns or sets whether the items in the combo box are sorted. (Default: False)

Throws:

An attempt was made to sort a that is attached to a data source.

SpellCheck

: Returns or sets whether the text in the is spell checked by the browser. (Default: False)

Text

: Returns or sets the text associated with this control. (Default: "")

Tools

: Returns the instance of associated with this control.

Watermark

: Returns or sets the text to show when the control is empty. (Default: null)

Methods

BeginUpdate()

Not used. Kept for compatibility.

Copy()

Copies the current selection in the text box to the Clipboard.

Cut()

Moves the current selection in the text box to the Clipboard.

EndUpdate()

Not used. Kept for compatibility.

FindString(text)

Returns the index of the first item in the that starts with the specified string.

Parameter

Type

Description

Returns: . The zero-based index of the first item found; returns -1 if no match is found.

FindString(text, startIndex)

Returns the index of the first item in the beyond the specified index that contains the specified string. The search is not case sensitive.

Parameter

Type

Description

Returns: . The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies .

FindStringExact(text)

Finds the first item in the combo box that matches the specified string.

Parameter

Type

Description

Returns: . The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies .

FindStringExact(text, startIndex)

Finds the first item after the specified index that matches the specified string.

Replaces the current selection in the text box with the contents of the Clipboard.

Events

The application may implement a different way to select the item when the user types a text and the ComboBox is validated. Set e.Handled to true to override the standard behavior.

Inherited By

Implements

DataGridView

Wisej.Web.DataGridView

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents a data grid control.

Constructors

DataGridView()

Initializes a new instance of the class.

Properties

AllowSortingDataSource

: Returns or sets whether the can automatically sort rows in the when the data is in an object. (Default: True)

When the is data-bound, sorting is delegated to the when it supports sorting (see ). Otherwise, if the data is in an object and is true, Wisej swaps the rows in the data source. This behavior is different than WinForms, where sorting of the data source is always delegated to the data source and is otherwise ignored. Setting to false reverts to the same behavior as in WinForms.

AllowUserToAddRows

Throws:

It's better not to touch this value unless you know what you are doing.

Throws:

It's better not to touch this value unless you know what you are doing.

Throws:

By default the DataGridView shows the open/close tree icons on the first visible and non-frozen column.

Methods

Returns whether all the cells are currently selected.

Adjusts the width of the column to fit the contents of its cells including the header cell.

Throws:

Adjusts the width of the column to fit the contents of its cells including the header cell.

Throws:

Adjusts the width of the specified column using the specified size mode.

Throws:

Adjusts the width of the specified column using the specified size mode.

Throws:

Adjusts the height of the column headers to fit the contents of the largest header.

Adjusts the height of the column headers based on the contents of the header in the specified column.

Throws:

Adjusts the width of all columns to fit the contents of their cells including the header cells.

Adjusts the width of all columns using the specified size mode.

Throws:

Adjusts the width of all columns using the specified size mode.

Throws:

Adjusts the height of the row to fit the contents of all its cells including the header cell.

Throws:

Adjusts the height of the row to fit the contents of all its cells including the header cell.

Throws:

Adjusts the height of the row using the specified size mode.

Throws:

Adjusts the height of the row using the specified size mode.

Throws:

Adjusts the width of the row headers using the specified size mode.

Throws:

Adjusts the width of the row headers using the specified size mode.

Throws:

Adjusts the width of the row headers based on the contents of the header in the specified row and using the specified size mode.

Throws:

Adjusts the width of the row headers based on the contents of the header in the specified row and using the specified size mode.

Throws:

Adjusts the heights of all rows in the client's data cache to fit the contents of all their cells, including the header cells.

Adjusts the heights of the rows using the specified size mode.

Throws:

Puts the current cell in edit mode.

Throws:

Cancels edit mode for the currently selected cell and discards any changes.

Clears the current selection.

Commits changes to cell without ending edit mode.

Throws:

Commits and ends the edit operation on the current cell.

Throws:

Returns the column index and row index that contain the specified x, y client coordinates.

Checks if the specified cell can enter edit mode.

Checks if the cell at the colIndex and rowIndex location can enter edit mode.

Checks if the cell at the cellAddress location can enter edit mode.

Checks if the specified cell is visible.

Checks if the cell at the colIndex and rowIndex location is visible.

Checks if the cell at the cellAddress location is visible.

Verifies that the cell address refers to a valid cell.

Verifies that the column index and row index refer to a valid cell.

Verifies that the column index refer to a valid column.

Verifies that the row index refer to a valid row.

Throws:

Removes the all the summary rows.

Removes the summary rows that match the specified summaryPosition .

Removes the summary rows grouped by groupFromCol .

Removes the summary rows grouped by groupFromCol and groupToCol .

Removes the summary rows grouped by groupFromCol .

Removes the summary rows grouped by groupFromCol and groupToCol .

Removes the summary rows that match the specified summaryPosition and grouped by groupFromCol .

Removes the summary rows that match the specified summaryPosition and grouped by groupFromCol and groupToCol .

Scrolls the specified cell into view.

Throws:

Scrolls the specified cell into view aligned according to the position specified by alignX and alignY , if possible.

Throws:

Scrolls the specified cell into view.

Throws:

Scrolls the specified cell into view aligned according to the position specified by alignX and alignY , if possible.

Throws:

Scrolls the specified cell into view.

Throws:

Scrolls the specified cell into view aligned according to the position specified by alignX and alignY , if possible.

Throws:

Scrolls the specified column into view.

Throws:

Scrolls the specified column into view aligned to the left or right according to the position specified by alignX .

Throws:

Scrolls the specified column into view.

Throws:

Scrolls the specified column into view aligned to the left or right according to position specified by alignX .

Throws:

Scrolls the specified row into view.

Throws:

Scrolls the specified row into view aligned to the top or bottom according to the position specified by alignY .

Throws:

Scrolls the specified row into view.

Throws:

Scrolls the specified row into view aligned to the top or bottom according to the position specified by alignY .

Throws:

Sets the currently focused cell.

Sets the state for the row at rowIndex .

Throws:

Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.

Events

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

Implements

DataGridViewCellCollection

Wisej.Web.DataGridViewCellCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

BaseCollection
- DataGridViewCellCollection

Represents a collection of cells in a DataGridViewRow.

public class DataGridViewCellCollection : BaseCollection, IList, IList<DataGridViewCell>, ICollection<DataGridViewCell>, IEnumerable<DataGridViewCell>

Public Class DataGridViewCellCollection
    Inherits BaseCollection
    Implements IList, IList(Of DataGridViewCell), ICollection(Of DataGridViewCell), IEnumerable(Of DataGridViewCell)

Constructors

DataGridViewCellCollection(row)

Initializes a new instance of the DataGridViewCellCollection class.

Name

Type

Description

Properties

Item(column)

DataGridViewCell: Returns or sets the cell contained in the specified column .

Throws:

ArgumentNullException The specified value when setting this property is null; or column is null.
InvalidOperationException The specified cell when setting this property already belongs to a DataGridView control, or the specified cell when setting this property already belongs to a DataGridViewRow
ArgumentNullException column is null.
ArgumentException The specified column does not belong to the same DataGridView that owns the cells.
ArgumentOutOfRangeException The index of the specified column is less than 0 or is equal to or greater than the number of cells in the collection.

DataGridViewCell: Returns or sets the cell at the provided index location.

Throws:

ArgumentNullException The specified value when setting this property is null.
InvalidOperationException The specified cell when setting this property already belongs to a DataGridView control, or the specified cell when setting this property already belongs to a DataGridViewRow.
ArgumentOutOfRangeException index is less than 0 or index is equal to or greater than the number of cells in the collection.

DataGridViewCell: Returns or sets the cell in the column with the provided name.

Throws:

ArgumentException columnName does not match the name of any columns in the control.
ArgumentNullException The specified value when setting this property is null; or columnName is null.
InvalidOperationException The specified cell when setting this property already belongs to a DataGridView control, or the specified cell when setting this property already belongs to a DataGridViewRow.

Methods

Adds a cell to the collection.

Returns: Int32. The position in which to insert the new element.

Throws:

InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or cell already belongs to a DataGridViewRow.

Adds an array of cells to the collection.

Throws:

ArgumentNullException cells is null.
InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or at least one value in cells is null, or at least one cell in cells already belongs to a DataGridViewRow, or at least two values in cells are references to the same DataGridViewCell.

Adds an array of cells to the collection.

Throws:

ArgumentNullException cells is null.
InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or at least one value in cells is null, or at least one cell in cells already belongs to a DataGridViewRow, or at least two values in cells are references to the same DataGridViewCell.

Clears all cells from the collection.

Throws:

InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control.

Determines whether the specified cell is contained in the collection.

Returns: Boolean. true if cell is in the collection; otherwise, false.

Copies the entire collection of cells into an array at a specified location within the array.

Returns the index of the specified cell.

Returns: Int32. The zero-based index of the value of cell parameter, if it is found in the collection; otherwise, -1.

Inserts a cell into the collection at the specified index.

Throws:

InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control, or cell already belongs to a DataGridViewRow.

Removes the specified cell from the collection.

Throws:

InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control.
ArgumentException cell could not be found in the collection.

Removes the cell at the specified index.

Throws:

InvalidOperationException The row that owns this DataGridViewCellCollection already belongs to a DataGridView control.

Events

CollectionChangeEventHandler Fired when the collection changes.

DataGridViewColumn

Wisej.Web.DataGridViewColumn

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

DataGridViewElement
- DataGridViewBand
  - DataGridViewColumn

Represents a column in a DataGridView control.

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

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

Properties

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

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)

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.

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

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

DataGridView: Returns the DataGridView control associated with this element.

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

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

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.

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

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.

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

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

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

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

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

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

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

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

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

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

Boolean: Returns true when the implementation class is DataGridViewRow.

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.

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.

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.

String: Returns or sets the name of the column.

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.

DataGridViewTriState: Returns or sets whether the column is resizable.

Boolean: Returns or sets whether the column is selected.

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

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

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

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)

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

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

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

Throws:

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

Methods

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

Resets the width to the default value.

Updates the component on the client.

Events

EventHandler Fired when the DataGridViewColumn is disposed.

Inherited By

Implements

DataGridViewDateTimePickerColumn

Wisej.Web.DataGridViewDateTimePickerColumn

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

DataGridViewElement
- DataGridViewBand
  - DataGridViewColumn
    DataGridViewDateTimePickerColumn

Represents a DataGridView column that contains a collection of DataGridViewDateTimePickerCell cells.

public class DataGridViewDateTimePickerColumn : DataGridViewColumn

Public Class DataGridViewDateTimePickerColumn
    Inherits DataGridViewColumn

Constructors

DataGridViewDateTimePickerColumn()

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

DataGridViewDateTimePickerColumn(cellTemplate)

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

Name

Type

Description

Properties

DataGridViewCell: Returns or sets the template used to model cell appearance.

Throws:

InvalidOperationException The type is null.
InvalidCastException The set type is not compatible with type DataGridViewDateTimePickerCell.

String: Returns or sets the custom date/time format string. (Default: "")

See Custom Date and Time Format Strings for the supported format definitions.

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

DateTimePickerFormat: Returns or sets the format of the date/time value displayed in the control. (Default: DateTime)

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

InvalidOperationException The value of the CellTemplate property is null.

DateTime: Returns or sets the maximum date and time that can be selected in the control.

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

ArgumentException The value assigned is not less than the MaximumDate value (12/31/9998).
SystemException The value assigned is less than the MinimumDateTime value (01/01/1753).
InvalidOperationException The value of the CellTemplate property is null.

DateTime: Returns or sets the minimum date and time that can be selected in the control.

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

ArgumentException The value assigned is not less than the MaximumDate value (12/31/9998).
SystemException The value assigned is less than the MinimumDateTime value (01/01/1753).
InvalidOperationException The value of the CellTemplate property is null.

Boolean: Returns or sets a value indicating if a spin button control (up-down control) is displayed and can be used to adjust the date/time value. (Default: False)

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

InvalidOperationException The value of the CellTemplate property is null.

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

Implements

DataGridViewMaskedTextBoxColumn

Wisej.Web.DataGridViewMaskedTextBoxColumn

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

DataGridViewElement
- DataGridViewBand
  - DataGridViewColumn
    DataGridViewMaskedTextBoxColumn

Represents a DataGridView column that contains a collection of DataGridViewTextBoxCell cells.

public class DataGridViewMaskedTextBoxColumn : DataGridViewColumn

Public Class DataGridViewMaskedTextBoxColumn
    Inherits DataGridViewColumn

Constructors

DataGridViewMaskedTextBoxColumn()

Initializes a new instance of the DataGridViewMaskedTextBoxColumn.

DataGridViewMaskedTextBoxColumn(cellTemplate)

Initializes a new instance of the DataGridViewMaskedTextBoxColumn.

Name

Type

Description

Properties

DataGridViewCell: Returns or sets the template used to model cell appearance.

Throws:

InvalidOperationException The type is null.
InvalidCastException The set type is not compatible with type DataGridViewTextBoxCell.

CultureInfo: Returns or sets the culture information associated with the masked cell.

String: Returns or sets the input mask. (Default: "")

The Mask is a string that defines the masking characters and the literals to display and process during user input and when reading the Value property. Server side masking is processed by an instance of the MaskedTextProvider class exposed by the MaskedTextProvider property. On the client side, the mask processing is performed by the "wisej.utils.MaskProvider.js" class while the user edits the input field.

If you change the Mask when the control already contains a value, it will apply the new mask to the existing text. The decimal (.), thousand (,), time (:), date (/), and currency ($) symbols default to displaying those symbols as defined by the application's culture. You can force a specific DataGridViewMaskedTextBoxColumn them to display symbols for another culture by using the Culture property. Otherwise you can set the application-wide culture by setting the CurrentCulture property.

Int32: Returns or sets the maximum number of characters that can be entered into the text box. (Default: 0)

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

InvalidOperationException The value of the CellTemplate property is null.

Char: Returns or sets the character used to represent the absence of user input in the cell's MaskedTextBox. (Default: _)

Throws:

ArgumentException The character specified when setting this property is not a valid prompt character, as determined by the IsValidPasswordChar method of the MaskedTextProvider class.
InvalidOperationException The prompt character specified is the same as the current password character, PasswordChar. The two are required to be different.

Boolean: Returns or sets whether the empty mask is shown in the cell when the value is null or empty. (Default: True)

MaskFormat: Returns or sets a value that determines whether literals and prompt characters are included in the formatted string. (Default: IncludeLiterals)

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

Implements

DataGridViewMaskedTextBoxCell

Wisej.Web.DataGridViewMaskedTextBoxCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

DataGridViewElement
- DataGridViewCell
  - DataGridViewMaskedTextBoxCell

Displays an editable MaskedTextBox control in a DataGridViewCell cell when in edit mode.

public class DataGridViewMaskedTextBoxCell : DataGridViewCell

Public Class DataGridViewMaskedTextBoxCell
    Inherits DataGridViewCell

Constructors

DataGridViewMaskedTextBoxCell()

Properties

Culture

CultureInfo: Returns or sets the culture information associated with the masked cell.

EditType

Type: Returns the type of the cell's editing control.

String: Returns or sets the input mask. (Default: "")

If you change the Mask when the control already contains a value, it will apply the new mask to the existing text. The decimal (.), thousand (,), time (:), date (/), and currency ($) symbols default to displaying those symbols as defined by the application's culture. You can force a specific DataGridViewMaskedTextBoxCell them to display symbols for another culture by using the Culture property. Otherwise you can set the application-wide culture by setting the CurrentCulture property.

Int32: Returns or sets the maximum number of characters that can be entered into the text box. (Default: 0)

Throws:

ArgumentOutOfRangeException The value is less than 0.

Char: Returns or sets the character used to represent the absence of user input in MaskedTextBox. (Default: _)

Throws:

ArgumentException The character specified when setting this property is not a valid prompt character, as determined by the IsValidPasswordChar method of the MaskedTextProvider class.
InvalidOperationException The prompt character specified is the same as the current password character, PasswordChar. The two are required to be different.

MaskFormat: Returns or sets a value that determines whether literals and prompt characters are included in the formatted string. (Default: IncludeLiterals)

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this cell.

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

Methods

Initializes the control used to edit the cell.

Throws:

ArgumentNullException editor is null.

Indicates whether the cell data should be updated on the client even if the user didn't change the value when editing.

Returns: Boolean.

Lists & Grids

CheckedListBox

Constructors

CheckedListBox()

Properties

CheckedIndices

Methods

Events

Implements

CheckedListBox.CheckedIndexCollection

Properties

Count

IsReadOnly

Item(index)

Methods

CheckedListBox.CheckedObjectCollection

Properties

Count

IsReadOnly

Item(index)

Methods

CheckedListBox.ObjectCollection

Methods

Add(item)

Add(item, isChecked)

ItemCheckEventArgs

Constructors

ItemCheckEventArgs(index, newCheckValue, currentValue)

Properties

CurrentValue

Index

Used By

ItemCheckEventHandler

Parameters

Fired By

ComboBox

Constructors

ComboBox()

Properties

AllowHtml

AutoCompleteMode

Methods

Events

Inherited By

Implements

ComboBox.ObjectCollection

Properties

Count

IsReadOnly

Item(index)

Methods

Events

BaseCollection

Constructors

BaseCollection()

Inherited By

ItemCheckEventHandler

Parameters

Fired By

CheckedListBox.CheckedIndexCollection

Properties

Count

IsReadOnly

Item(index)

Methods

Contains(index)

CopyTo(array, index)

GetEnumerator()

IndexOf(index)

ItemCheckEventArgs

Constructors

ItemCheckEventArgs(index, newCheckValue, currentValue)

Properties

CurrentValue

Index

NewValue

Used By

CheckedListBox.CheckedObjectCollection

Properties

Count