DataGridViewBand.Selected Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: DataGridViewBand.cs

Source:: DataGridViewBand.cs

Source:: DataGridViewBand.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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; }

[<System.ComponentModel.Browsable(false)>]
member this.Selected : bool with get, set

Public Overridable Property Selected As Boolean

Property Value

Boolean

true if the band is selected; otherwise, false.

Attributes: BrowsableAttribute

Exceptions

InvalidOperationException

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

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9

Share via