DataGridViewBand

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• DataGridViewElement
  • DataGridViewBand

Represents a linear collection of elements in a DataGridView control.

C#

public abstract class DataGridViewBand : DataGridViewElement, ICloneable, IUserData

VB.NET

Public MustInherit Class DataGridViewBand
    Inherits DataGridViewElement
    Implements ICloneable, IUserData

Properties

ContextMenu

ContextMenu: Returns or sets the shortcut menu for the row or the column object. (Default: null)

Value: The ContextMenu associated with the current DataGridViewBand. The default is null.

DefaultCellStyle

DataGridViewCellStyle: Returns or sets the default cell style of the band.

Value: The DataGridViewCellStyle associated with the DataGridViewBand.

DefaultHeaderCellType

Type: Returns or sets the run-time type of the default header cell.

Value: A Type that describes the run-time class of the object used as the default header cell.

Throws:

• ArgumentException The specified value when setting this property is not a Type representing DataGridViewHeaderCell or a derived type.

DefaultMinimumSize

Int32: Returns the default minimum size for the band (row or column.)

DefaultSize

Int32: Returns the default size for the band (row or column.)

Displayed

Boolean: Returns a value indicating whether the band is currently displayed on screen.

Value: true if the band is currently displayed in the visible range; otherwise, false.

Frozen

Boolean: Returns or sets whether the band will move when a user scrolls through the DataGridView. (Default: False)

Value: true if the band cannot be scrolled from view; otherwise, false. The default is false.

HasDefaultCellStyle

Boolean: Returns a value indicating whether the DefaultCellStyle property has been set.

Value: true if the DefaultCellStyle property has been set; otherwise, false.

HasUserData

Boolean: Checks if the UserData dynamic object was created and has any value.

HeaderCellCore

DataGridViewHeaderCell: Returns or sets the header cell of the DataGridViewBand.

Value: A DataGridViewHeaderCell representing the header cell of the DataGridViewBand.

Throws:

• ArgumentException The specified value when setting this property is not a DataGridViewRowHeaderCell and this DataGridViewBand instance is of type DataGridViewRow; or the specified value when setting this property is not a DataGridViewColumnHeaderCell and this DataGridViewBand instance is of type DataGridViewColumn.

Index

Int32: Returns the relative position of the band within the DataGridView control.

Value: The zero-based position of the band in the DataGridViewRowCollection or DataGridViewColumnCollection that it is contained within. The default is -1, indicating that there is no associated DataGridView control.

InheritedStyle

DataGridViewCellStyle: Returns the cell style in effect for the current band, taking into account style inheritance.

Value: A DataGridViewCellStyle associated with the DataGridViewBand. The default is null.

IsRow

Boolean: Returns true when the implementation class is DataGridViewRow.

ReadOnly

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

Value: true if the user cannot edit the band's cells; otherwise, false. The default is false.

Resizable

DataGridViewTriState: Returns or sets whether the band can be resized in the user interface (UI).

Value: One of the DataGridViewTriState values. The default is True.

Selected

Boolean: Returns or sets whether the band is in a selected user interface (UI) state.

Value: true if the band is selected; otherwise, false.

Tag

Object: Returns or sets the object that contains data to associate with the band.

Value: An Object that contains information associated with the band. The default is null.

UserData

Object: Returns a dynamic object that can be used to store custom data in relation to this band.

Visible

Boolean: Returns or sets whether the band is visible to the user. (Default: True)

Value: true if the band is visible; otherwise, false. The default is true.

Throws:

• InvalidOperationException The specified value when setting this property is false and the band is the row for new records.

Methods

Clone()

Creates an exact copy of this band.

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

Dispose(disposing)

Releases the resources used by the DataGridViewBand.

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

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.
DataGridViewColumn	Represents a column in a DataGridView control.
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.
DataGridViewRow	Represents a row in a DataGridView control.
DataGridViewSummaryRow	Represents a summary row in a DataGridView control.

Implements

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