Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid.Converters Namespace / StatResultConverter Class / Convert Method
The result of a statistical function.
The target type is ignored by the StatResultConverter.

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.

Composite format strings use braces ("{}") to identify place-holders, which causes an issue when providing a format string to a StatResultConverter in XAML; therefore, the StatResultConverter supports square brackets ("[]") as a substitute for braces. For example, if normally {0:#0.0} would have been used, it would be replaced with [#0.0] when using a StatResultConverter. If braces are preferred, the format string must be preceded with a closing brace (e.g., ConverterParameter={}{0:#0.0}}).

When using square brackets, the 0: that represents the place-holder must be omitted otherwise an exception will be thrown.
The culture info is ignored by the StatResultConverter.


In This Topic
    Convert Method (StatResultConverter)
    In This Topic
    Converts the specified value using the composite format string specified as parameter.
    Syntax
    'Declaration
     
    Public Overrides Function Convert( _
       ByVal value As Object, _
       ByVal targetType As Type, _
       ByVal parameter As Object, _
       ByVal culture As CultureInfo _
    ) As Object
    'Usage
     
    Dim instance As StatResultConverter
    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 override object Convert( 
       object value,
       Type targetType,
       object parameter,
       CultureInfo culture
    )

    Parameters

    value
    The result of a statistical function.
    targetType
    The target type is ignored by the StatResultConverter.
    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.

    Composite format strings use braces ("{}") to identify place-holders, which causes an issue when providing a format string to a StatResultConverter in XAML; therefore, the StatResultConverter supports square brackets ("[]") as a substitute for braces. For example, if normally {0:#0.0} would have been used, it would be replaced with [#0.0] when using a StatResultConverter. If braces are preferred, the format string must be preceded with a closing brace (e.g., ConverterParameter={}{0:#0.0}}).

    When using square brackets, the 0: that represents the place-holder must be omitted otherwise an exception will be thrown.
    culture
    The culture info is ignored by the StatResultConverter.

    Return Value

    The converted value.
    Remarks

    The messages returned by a StatResultConverter when an exception occurs during the calculation of a statistical function's result depend on the type of the exception that was thrown. The following table provides a list of exceptions for which default messages have been provided: 

    Exception Default message
    DivideByZeroException #DIV/0#
    Exception #[Exception.Message]#
    InvalidSourcePropertyNameException #[InvalidSourcePropertyNameException.SourcePropertyName]#
    InvalidValueException #VALUE#
    OverflowException #OVER#
     
    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