Xceed Toolkit Plus for WPF v5.0 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid.Converters Namespace / StringFormatConverter Class / Convert Method
The value to convert.
The target type is ignored by the StringFormatConverter.

A composite format string. If a FormatProvider has been provided, it will be used in combination with the format string to convert the value (see also Composite Formatting topic in Windows SDK).

If parameter is a null reference (Nothing in Visual Basic), value will be returned unmodified.

The culture info is ignored by the StringFormatConverter.


In This Topic
    Convert Method (StringFormatConverter)
    In This Topic
    Converts a value to a string using the specified composite string format.
    Syntax
    'Declaration
     
    Public Overridable Function Convert( _
       ByVal value As Object, _
       ByVal targetType As Type, _
       ByVal parameter As Object, _
       ByVal culture As CultureInfo _
    ) As Object
    'Usage
     
    Dim instance As StringFormatConverter
    Dim value As Object
    Dim targetType As Type
    Dim parameter As Object
    Dim culture As CultureInfo
    Dim value As Object
     
    value = instance.Convert(value, targetType, parameter, culture)
    public virtual object Convert( 
       object value,
       Type targetType,
       object parameter,
       CultureInfo culture
    )

    Parameters

    value
    The value to convert.
    targetType
    The target type is ignored by the StringFormatConverter.
    parameter

    A composite format string. If a FormatProvider has been provided, it will be used in combination with the format string to convert the value (see also Composite Formatting topic in Windows SDK).

    If parameter is a null reference (Nothing in Visual Basic), value will be returned unmodified.

    culture
    The culture info is ignored by the StringFormatConverter.
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also