Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

DxDropDownBox.GetDisplayText() Method

Returns a text defined by the QueryDisplayText function.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

#Declaration

C#
public string GetDisplayText()

#Returns

Type Description
String

The editor display text.

#Remarks

The DxDropDownBox‘s input element is read-only for users. Use the Value property to assign an editor value programmatically and implement the QueryDisplayText function to define how the editor value is displayed in the input element.

Call the GetDisplayText method to get the text defined by the QueryDisplayText function.

The following code snippet uses EditBoxDisplayTemplate to customize edit box content. The QueryDisplayText function concatenates the last names of selected employees. The GetDisplayText method is called to get the function result and display it in the template.

<DxDropDownBox @ref="ddbox" @bind-Value="Value" QueryDisplayText="QueryText" CssClass="ddBox">
    <EditBoxDisplayTemplate>
        <b>Selected employees:&nbsp;</b> @ddbox.GetDisplayText()
    </EditBoxDisplayTemplate>
    <DropDownBodyTemplate>
        <DxListBox Data="@ListBoxData" TData="Employee" TValue="Employee"
                    Values="@(GetListBoxValues(context.DropDownBox))"
                    ValuesChanged="@(values => ListBoxValuesChanged(values, context.DropDownBox))"
                    TextFieldName="@nameof(Employee.Text)"
                    SelectionMode="ListBoxSelectionMode.Multiple"
                    ShowCheckboxes="true"
                    CssClass="templateListbox" />
    </DropDownBodyTemplate>
</DxDropDownBox>

@code {
    DxDropDownBox ddbox;
    IEnumerable<Employee> ListBoxData { get; set; }
    object Value { get; set; }

    string QueryText(DropDownBoxQueryDisplayTextContext arg) {
        var names = (arg.Value as IEnumerable<Employee>)?.Select(x => x.LastName);
        return names != null ? string.Join(",", names) : string.Empty;
    }

    IEnumerable<Employee> GetListBoxValues(IDropDownBox dropDownBox) {
        return dropDownBox.Value as IEnumerable<Employee>;
    }

    void ListBoxValuesChanged(IEnumerable<Employee> values, IDropDownBox dropDownBox) {
        dropDownBox.BeginUpdate();
        dropDownBox.Value = values;
        dropDownBox.EndUpdate();
    }

    protected override async Task OnInitializedAsync() {
        ListBoxData = await NwindDataService.GetEmployeesAsync();
    }
}

DropDownBox with Edit Box Template

#Implements

See Also