DataGridViewBand.Selected Property

Definition

Gets or sets a value indicating whether the band is in a selected user interface (UI) state.

public:
 virtual property bool Selected { bool get(); void set(bool value); };
[System.ComponentModel.Browsable(false)]
public virtual bool Selected { get; set; }
member this.Selected : bool with get, set
Public Overridable Property Selected As Boolean

Property Value

true if the band is selected; otherwise, false.

Attributes

Exceptions

The specified value when setting this property is true, but the band has not been added to a DataGridView control.

-or-

This property is being set on a shared DataGridViewRow.

Examples

The following code example illustrates the use of this property.

void dataGridView1_ColumnHeaderMouseClick(
    object sender, DataGridViewCellMouseEventArgs e)
{
    this.dataGridView1.SelectionMode =
        DataGridViewSelectionMode.ColumnHeaderSelect;
    this.dataGridView1.Columns[e.ColumnIndex].HeaderCell
        .SortGlyphDirection = SortOrder.None;
    this.dataGridView1.Columns[e.ColumnIndex].Selected = true;
}

void dataGridView1_RowHeaderMouseClick(
    object sender, DataGridViewCellMouseEventArgs e)
{
    this.dataGridView1.SelectionMode =
        DataGridViewSelectionMode.RowHeaderSelect;
    this.dataGridView1.Rows[e.RowIndex].Selected = true;
}
Private Sub dataGridView1_ColumnHeaderMouseClick( _
    ByVal sender As Object, ByVal e As DataGridViewCellMouseEventArgs) _
    Handles dataGridView1.ColumnHeaderMouseClick

    Me.dataGridView1.SelectionMode = _
        DataGridViewSelectionMode.ColumnHeaderSelect
    Me.dataGridView1.Columns(e.ColumnIndex).HeaderCell _
        .SortGlyphDirection = SortOrder.None
    Me.dataGridView1.Columns(e.ColumnIndex).Selected = True

End Sub

Private Sub dataGridView1_RowHeaderMouseClick( _
    ByVal sender As Object, ByVal e As DataGridViewCellMouseEventArgs) _
    Handles dataGridView1.RowHeaderMouseClick

    Me.dataGridView1.SelectionMode = _
        DataGridViewSelectionMode.RowHeaderSelect
    Me.dataGridView1.Rows(e.RowIndex).Selected = True

End Sub

Remarks

This property can be set only if a DataGridView with the SelectionMode property enabled is associated with the band.

Applies to

See also