Convert Method (StringFormatConverter)

Takes a series of values to use in a call to the System.String.Format(System.IFormatProvider,System.String,System.Object[]) to create a string.

Syntax

Visual Basic

'Declaration
 
Public Function Convert( _
   ByVal values() As Object, _
   ByVal targetType As Type, _
   ByVal parameter As Object, _
   ByVal culture As CultureInfo _
) As Object

C#

public object Convert( 
   object[] values,
   Type targetType,
   object parameter,
   CultureInfo culture
)

Parameters

values

An array providing the arguments for the call to System.String.Format(System.IFormatProvider,System.String,System.Object[]). If the first element is null or System.Windows.DependencyProperty.UnsetValue, the converter culture will be used.

targetType

The type to which the converter must be convert the value. This parameter is not used. A String value is always returned

parameter

The string to use as the format. If null, then the first value is assumed to be the format.

culture

The culture used as the IFormatProvider for the Format method call.

Return Value

System.Windows.DependencyProperty.UnsetValue if the parameters do not match the information. Otherwise a formatted string is returned.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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