DimensionTopNOptions.Enabled Property

Gets or sets whether the Top N Values feature is enabled.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(false)]
public bool Enabled { get; set; }

VB.NET

<DefaultValue(False)>
Public Property Enabled As Boolean

Property Value

Type	Default	Description
Boolean	false	true, to enable the Top N Values feature; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Enabled
Dimension	.TopNOptions .Enabled

Remarks

Set the Enabled property to true to show only a specified number (DimensionTopNOptions.Count) of top or bottom (depending on the DimensionTopNOptions.Mode) dimension values, provided that these value are ranged by a particular measure (DimensionTopNOptions.Measure).

You can also introduce the “Others” value that aggregates the remaining dimension values. To do this, use the DimensionTopNOptions.ShowOthers property.

Note that when the Top N Values feature is enabled, dimension values are forcefully sorted by the specified measure and the sort order is descending if top values are displayed and ascending if bottom values are displayed.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Enabled property.

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-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L109

if( (dashboardItem.Metadata.ID.TopNOptions.Enabled && dashboardItem.Metadata.ID.TopNOptions.ShowOthers)
    || (dashboardItem.Metadata.ParentID.TopNOptions.Enabled && dashboardItem.Metadata.ParentID.TopNOptions.ShowOthers)) {

wpf-dashboard-how-to-bind-to-object-list/CS/WpfDashboard_ObjectDataSource/MainWindow.xaml.cs#L41

pies.Arguments.Add(salesPersonArgument);
salesPersonArgument.TopNOptions.Enabled = true;
salesPersonArgument.TopNOptions.Count = 3;

winforms-dashboard-designer-bind-a-dashboard-to-a-list-object/CS/Dashboard_BindingToList/Form1.cs#L30

pies.Arguments.Add(salesPersonArgument);
salesPersonArgument.TopNOptions.Enabled = true; salesPersonArgument.TopNOptions.Count = 3;
salesPersonArgument.TopNOptions.Measure = quantity;

VB.NET

wpf-dashboard-how-to-bind-to-object-list/VB/WpfDashboard_ObjectDataSource/MainWindow.xaml.vb#L37

pies.Arguments.Add(salesPersonArgument)
salesPersonArgument.TopNOptions.Enabled = True
salesPersonArgument.TopNOptions.Count = 3

winforms-dashboard-designer-bind-a-dashboard-to-a-list-object/VB/Dashboard_BindingToList/Form1.vb#L33

pies.Arguments.Add(salesPersonArgument)
salesPersonArgument.TopNOptions.Enabled = True
salesPersonArgument.TopNOptions.Count = 3

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L119

If (dashboardItem.Metadata.ID.TopNOptions.Enabled AndAlso dashboardItem.Metadata.ID.TopNOptions.ShowOthers) OrElse (dashboardItem.Metadata.ParentID.TopNOptions.Enabled AndAlso dashboardItem.Metadata.ParentID.TopNOptions.ShowOthers) Then
    validationError = "The Tree List Item does not support the ""Show Others value"" option in the ID and Parent ID data sections"