Measure.WindowDefinition Property

Gets or sets the window definition used to apply a calculation to values of the current measure.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v19.1.Core.dll

Declaration

C#

[DefaultValue(null)]
public MeasureCalculationWindowDefinition WindowDefinition { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property WindowDefinition As MeasureCalculationWindowDefinition

Property Value

Type	Default	Description
MeasureCalculationWindowDefinition	*null*	A MeasureCalculationWindowDefinition descendant that specifies the window definition used to apply a calculation to values of the current measure.

Remarks

To apply a calculation to values of the required measure, perform the following steps.

• Create the MeasureCalculation class instance, initialize its settings and assign the resulting object to the Measure.Calculation property. As an alternative, you can create a Measure.Expression with the calculation functions.
• Specify a window to apply a calculation. To do this, create and initialize the descendant of the MeasureCalculationWindowDefinition class (depending on the type of the dashboard item) and assign the resulting object to the WindowDefinition property.

Example

The code snippet adds a new measure to the Pivot dashboard item and specifies a window calculation to compute the difference between measure values across a window. The calculation is performed along columns of the Pivot dashboard item.

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
// ...
PivotDashboardItem pivotItem = dashboardViewer1.Dashboard.Items[pivotItemName] as PivotDashboardItem;
if (pivotItem != null)
{
    Measure extendedPrice = new Measure("Extended Price")
    {
        Name = "Diff",
        ShowGrandTotals = false
    };
    PivotWindowDefinition pivotWindowDefinition = new PivotWindowDefinition();
    pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns;
    extendedPrice.WindowDefinition = pivotWindowDefinition;
    extendedPrice.Calculation = new DifferenceCalculation() { DifferenceType = DifferenceType.Absolute };
    pivotItem.Values.Add(extendedPrice);
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
' ...
Dim pivotItem As PivotDashboardItem = TryCast(dashboardViewer1.Dashboard.Items(pivotItemName), PivotDashboardItem)
If pivotItem IsNot Nothing Then
    Dim extendedPrice As New Measure("Extended Price") With { _
        .Name = "Diff", _
        .ShowGrandTotals = False _
    }
    Dim pivotWindowDefinition As New PivotWindowDefinition()
    pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns
    extendedPrice.WindowDefinition = pivotWindowDefinition
    extendedPrice.Calculation = New DifferenceCalculation() With {.DifferenceType = DifferenceType.Absolute}
    pivotItem.Values.Add(extendedPrice)
End If

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the WindowDefinition 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-window-calculation-example/CS/WindowCalculationExample/Form1.cs#L46

pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns;
extendedPrice.WindowDefinition = pivotWindowDefinition;
extendedPrice.Calculation = new DifferenceCalculation() { DifferenceType = DifferenceType.Absolute };

VB.NET

winforms-dashboard-window-calculation-example/VB/WindowCalculationExample/Form1.vb#L37

pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns
extendedPrice.WindowDefinition = pivotWindowDefinition
extendedPrice.Calculation = New DifferenceCalculation() With {.DifferenceType = DifferenceType.Absolute}