NamedDataItemContainer.GetDisplayName() Method

Gets the item’s name displayed in the dashboard.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v23.2.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public string GetDisplayName()

VB.NET

Public Function GetDisplayName As String

Returns

Type	Description
String	A text displayed in the dashboard as an item’s name or caption.

Remarks

The GetDisplayName() method returns the actual text displayed as an item’s name in the dashboard.

Consider a grid’s column. The string displayed as its caption is created when a dashboard is loaded. It is constructed automatically from the data field’s name. If the name is assigned in code, that is, if the Name property is not null, its value is used as a column’s caption. The end-user can rename a data item in the Dashboard Designer. If it happens, the specified name becomes the column’s caption. To get the column’s caption displayed in the dashboard grid’s column header, use the GetDisplayName method.

Other dashboard items obtain their display names using the same procedure. The GetDisplayName method provides the developer with the ability to obtain the final text displayed in the dashboard.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDisplayName() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.cs#L76

public override string ToString() {
    return Column.GetDisplayName();
}

VB.NET

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.vb#L77

Public Overrides Function ToString() As String
    Return Column.GetDisplayName()
End Function