CustomItemMetadata.SetPropertyValue(DataItem, String) Method

Applies an individual data section property value.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

protected void SetPropertyValue(
    DataItem newValue,
    string propertyName = null
)

VB.NET

Protected Sub SetPropertyValue(
    newValue As DataItem,
    propertyName As String = Nothing
)

Parameters

Name	Type	Description
newValue	DataItem	A measure or dimension whose values are displayed in a custom item.

Optional Parameters

Name	Type	Default	Description
propertyName	String	null	The data section property name from CustomItemMetadata.

Remarks

The following code snippet shows how to declare an individual data section Weight, Target and Source properties in the CustomItemMetadata descendant:

SankeyItemMetadata.cs

using DevExpress.DashboardCommon;

namespace CustomItemsSample {
    public class SankeyItemMetadata : CustomItemMetadata {
        public Measure Weight {
            get { return GetPropertyValue<Measure>(); }
            set { SetPropertyValue(value); }
        }
        public Dimension Target {
            get { return GetPropertyValue<Dimension>(); }
            set { SetPropertyValue(value); }
        }
        public Dimension Source {
            get { return GetPropertyValue<Dimension>(); }
            set { SetPropertyValue(value); }
        }
    }
}

SankeyItemMetadata.vb

Imports Microsoft.VisualBasic
Imports DevExpress.DashboardCommon

Namespace CustomItemsSample
    Public Class SankeyItemMetadata
        Inherits CustomItemMetadata
        Public Property Weight() As Measure
            Get
                Return GetPropertyValue(Of Measure)()
            End Get
            Set(ByVal value As Measure)
                SetPropertyValue(value)
            End Set
        End Property
        Public Property Target() As Dimension
            Get
                Return GetPropertyValue(Of Dimension)()
            End Get
            Set(ByVal value As Dimension)
                SetPropertyValue(value)
            End Set
        End Property
        Public Property Source() As Dimension
            Get
                Return GetPropertyValue(Of Dimension)()
            End Get
            Set(ByVal value As Dimension)
                SetPropertyValue(value)
            End Set
        End Property
    End Class
End Namespace