DxHtmlElement.Select(Boolean) Method

Gets or sets whether this element is selected. Focused elements are styled with the “main_class_name:select” CSS pseudo-class.

Namespace: DevExpress.Utils.Html

Assembly: DevExpress.Data.Desktop.v24.1.dll

NuGet Packages: DevExpress.Data.Desktop, DevExpress.ExpressApp.Win.Design

Declaration

C#

public virtual bool Select(
    bool value
)

VB.NET

Public Overridable Function Select(
    value As Boolean
) As Boolean

Parameters

Name	Type	Description
value	Boolean	true to select the element and apply the “:select” CSS pseudo-class; false to deselect the element and apply the regular CSS style.

Returns

Type	Description
Boolean	true if the element was successfully selected; otherwise, false.

Remarks

The code below illustrates how to select a clicked item within a DirectXForm, and deselect the previously selected item.

<div class="pageButtonContainer">
    <div class="headerbutton" id="pagePortfolio">Portfolio</div>
    <div class="headerbutton" id="pageFavorites">Favorites</div>
    <div class="headerbutton" id="pageTrade">Trade</div>
    <div class="headerbutton" id="pageAnalysis">Analysis</div>
    <div class="headerbutton" id="pageNews">News</div>
</div>

.headerbutton{
    height: 35px;
    width: 100px;
    color: @ControlText;
    font: 14px 'Inter';
    text-align: center;
    display: flex;
    flex-direction: column;
    justify-content: center;
}
.headerbutton:hover{
    border-bottom: 3px solid @Blue;
    font: 14px 'Inter';
    font-weight: bolder;
}
.headerbutton:select{
    border-bottom: 3px solid @Blue;
    font: 14px 'Inter';
    font-weight: bolder;
    color: @Blue;
}

C#

// Backing field for the SelectedElement property
DxHtmlElement _selectedElement;

// Change the SelectedElement property value on mouse click
void Form1_HtmlElementMouseDown(object sender, DxHtmlElementMouseEventArgs e) {
    if (e.ElementId.StartsWith("page")) {
        SelectedElement = e.Element;
        (e.MouseArgs as DXMouseEventArgs).Handled = true;
    }
}

// Raise OnSelectedPageChanged whenever the property value changes
protected DxHtmlElement SelectedElement {
    get { return _selectedElement; }
    set {
        if (value == _selectedElement)
            return;
        var prev = _selectedElement;
        _selectedElement = value;
        OnSelectedPageChanged(prev, _selectedElement);
    }
}

// Swap selection states for two elements
void OnSelectedPageChanged(DxHtmlElement prev, DxHtmlElement current) {
    prev?.Select(false);
    current?.Select(true);
}

VB.NET

' Backing field for the SelectedElement property
Dim _selectedElement As DxHtmlElement

' Change the SelectedElement property value on mouse click
Private Sub Form1_HtmlElementMouseDown(ByVal sender As Object, ByVal e As DxHtmlElementMouseEventArgs)
    If e.ElementId.StartsWith("page") Then
        SelectedElement = e.Element
        TryCast(e.MouseArgs, DXMouseEventArgs).Handled = True
    End If
End Sub

' Raise OnSelectedPageChanged whenever the property value changes
Protected Property SelectedElement() As DxHtmlElement
    Get
        Return _selectedElement
    End Get
    Set(ByVal value As DxHtmlElement)
        If value Is _selectedElement Then
            Return
        End If
        Dim prev = _selectedElement
        _selectedElement = value
        OnSelectedPageChanged(prev, _selectedElement)
    End Set
End Property

' Swap selection states for two elements
Private Sub OnSelectedPageChanged(ByVal prev As DxHtmlElement, ByVal current As DxHtmlElement)
    prev?.Select(False)
    current?.Select(True)
End Sub