ICustomPropertyValueConverterAttribute<T>.ConvertToString(T) Method

Converts a custom property value declared in metadata to a string.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

string ConvertToString(
    T value
)

VB.NET

Function ConvertToString(
    value As T
) As String

Parameters

Name	Type	Description
value	T	A custom property’s value.

Returns

Type	Description
String	A custom property’s value in string format.

Remarks

The following code snippet converts the value of the ShowLegend custom property declared in metadata from its original type to a string and vice versa:

FunnelItemMetadata.cs

using System;
using System.ComponentModel;
using DevExpress.DashboardCommon;

namespace TutorialsCustomItems {
    public class FunnelItemMetadata : CustomItemMetadata {
        // ...
        [ShowLegendCustom]
        public bool ShowLegend {
            get { return GetCustomPropertyValue<bool>(); }
            set { SetCustomPropertyValue(value); }
        }
        public class ShowLegendCustomAttribute : Attribute, ICustomPropertyValueConverterAttribute<bool>, ICustomPropertyHistoryAttribute<bool>{
            // ...
            public string ConvertToString(bool value){
                return value.ToString();
            }
            public bool ConvertFromString(string strValue){
                bool result;
                Boolean.TryParse(strValue, out result);
                return result;
            }
        }
    }
}

FunnelItemMetadata.vb

Imports System
Imports System.ComponentModel
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
         Public Class ShowLegendCustomAttribute
     Inherits Attribute
     Implements ICustomPropertyValueConverterAttribute(Of Boolean), ICustomPropertyHistoryAttribute(Of Boolean)
            ' ...
            Public Function ConvertToString(ByVal value As Boolean) As String
                Return value.ToString()
      End Function
            Public Function ConvertFromString(ByVal strValue As String) As Boolean
                Dim result As Boolean = Nothing
                Boolean.TryParse(strValue, result)
                Return result
            End Function

        End Class
    End Class
End Namespace