CustomItemMetadata.SetCustomPropertyValue<T>(T, String) Method

Applies a custom property value.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

protected void SetCustomPropertyValue<T>(
    T value,
    string propertyName = null
)

VB.NET

Protected Sub SetCustomPropertyValue(Of T)(
    value As T,
    propertyName As String = Nothing
)

Parameters

Name	Type	Description
value	T	A custom property value.

Optional Parameters

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

Type Parameters

Name	Description
T	A custom property data type.

Remarks

The following code snippet shows how to declare a custom ShowLegend property in the CustomItemMetadata descendant:

FunnelItemMetadata.cs

using DevExpress.DashboardCommon;

namespace TutorialsCustomItems {
    public class FunnelItemMetadata : CustomItemMetadata {
        // ...
        [ShowLegendCustom]
        public bool ShowLegend {
            get { return GetCustomPropertyValue<bool>(); }
            set { SetCustomPropertyValue(value); }
        }
    }
}

FunnelItemMetadata.vb

Imports DevExpress.DashboardCommon

Namespace TutorialsCustomItems
    Public Class FunnelItemMetadata
        Inherits CustomItemMetadata
        ' ...
        <ShowLegendCustom>
        Public Property ShowLegend() As Boolean
            Get
                Return GetCustomPropertyValue(Of Boolean)()
            End Get
            Set(ByVal value As Boolean)
                SetCustomPropertyValue(value)
            End Set
        End Property
    End Class
End Namespace