StringFormatValueConverter Class
Definition
A value converter which calls string.Format(string,object)
public class StringFormatValueConverter
Constructors
| Name | Description |
|---|---|
| StringFormatValueConverter | Initializes a new instance of the Avalonia.Data.Converters.StringFormatValueConverter class. |
StringFormatValueConverter Constructor
Initializes a new instance of the Avalonia.Data.Converters.StringFormatValueConverter class.
public StringFormatValueConverter(string format, Avalonia.Data.Converters.IValueConverter inner)
Parameters
format string
The format string.
inner Avalonia.Data.Converters.IValueConverter
An optional inner converter to be called before the format takes place.
Methods
| Name | Description |
|---|---|
| Convert | Converts a value. |
| ConvertBack | Converts a value. |
Convert Method
Converts a value.
public object Convert(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
Parameters
value object
The value to convert.
targetType Type
The type of the target.
parameter object
A user-defined parameter.
culture System.Globalization.CultureInfo
The culture to use.
Returns
object
The converted value.
Remarks
This method should not throw exceptions. If the value is not convertible, return a Avalonia.Data.BindingNotification in an error state. Any exceptions thrown will be treated as an application exception.
ConvertBack Method
Converts a value.
public object ConvertBack(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
Parameters
value object
The value to convert.
targetType Type
The type of the target.
parameter object
A user-defined parameter.
culture System.Globalization.CultureInfo
The culture to use.
Returns
object
The converted value.
Remarks
This method should not throw exceptions. If the value is not convertible, return a Avalonia.Data.BindingNotification in an error state. Any exceptions thrown will be treated as an application exception.
Properties
| Name | Description |
|---|---|
| Format | Gets the format string. |
| Inner | Gets an inner value converter which will be called before the string format takes place. |
Format Property
Gets the format string.
public string Format { get; set; }
Inner Property
Gets an inner value converter which will be called before the string format takes place.
public Avalonia.Data.Converters.IValueConverter Inner { get; set; }