Meziantou.Framework

ConvertUtilities Class

Namespace
Meziantou.Framework
Assembly
Meziantou.Framework.TypeConverter.dll
Package
Meziantou.Framework.TypeConverter 4.0.4
Source
ConvertUtilities.cs
Available in package assets
net10.0net11.0

Provides utility methods for converting values between types with more flexibility than System.Convert.

public static class ConvertUtilities

Example

// Using TryChangeType
Assert.True(ConvertUtilities.TryChangeType("42", CultureInfo.InvariantCulture, out int value));
Assert.Equal(42, value);

// Using ChangeType with default value
var result = ConvertUtilities.ChangeType<int>("invalid", defaultValue: 0, CultureInfo.InvariantCulture);
Assert.Equal(0, result);

// Convert with culture-specific formatting
var cultureInfo = CultureInfo.GetCultureInfo("fr-FR");
var number = ConvertUtilities.ChangeType<decimal>("1234,56", defaultValue: 0m, provider: cultureInfo);
Assert.Equal(1234.56m, number);

Properties

NameDescription
DefaultConverterGets the default converter instance used by the utility methods.

DefaultConverter

ConvertUtilities.cs

Gets the default converter instance used by the utility methods.

public static IConverter DefaultConverter { get; }

Property value

IConverter

Methods

NameDescription
ChangeType(IConverter, object?, Type)Converts an input value to a specified type using a custom converter, or returns null if conversion fails.
ChangeType(IConverter, object?, Type, object?)Converts an input value to a specified type using a custom converter, or returns a default value if conversion fails.
ChangeType(IConverter, object?, Type, object?, IFormatProvider?)Converts an input value to a specified type using a custom converter, or returns a default value if conversion fails.
ChangeType(object?, Type)Converts an input value to a specified type using the default converter, or returns null if conversion fails.
ChangeType(object?, Type, object?)Converts an input value to a specified type using the default converter, or returns a default value if conversion fails.
ChangeType(object?, Type, object?, IFormatProvider?)Converts an input value to a specified type using the default converter, or returns a default value if conversion fails.
ChangeType<T>(IConverter, object?)Converts an input value to the specified type using a custom converter, or returns the default value of the type if conversion fails.
ChangeType<T>(IConverter, object?, T)Converts an input value to the specified type using a custom converter, or returns a default value if conversion fails.
ChangeType<T>(IConverter, object?, T, IFormatProvider?)Converts an input value to the specified type using a custom converter, or returns a default value if conversion fails.
ChangeType<T>(object?)Converts an input value to the specified type using the default converter, or returns the default value of the type if conversion fails.
ChangeType<T>(object?, T)Converts an input value to the specified type using the default converter, or returns a default value if conversion fails.
ChangeType<T>(object?, T, IFormatProvider?)Converts an input value to the specified type using the default converter, or returns a default value if conversion fails.
TryChangeType(IConverter, object?, Type, IFormatProvider?, object?)Attempts to convert an input value to a specified type using a custom converter.
TryChangeType(IConverter, object?, Type, object?)Attempts to convert an input value to a specified type using a custom converter and invariant culture.
TryChangeType(object?, Type, IFormatProvider?, object?)Attempts to convert an input value to a specified type using the default converter.
TryChangeType(object?, Type, object?)Attempts to convert an input value to a specified type using the default converter and invariant culture.
TryChangeType<T>(IConverter, object?, IFormatProvider?, T)Attempts to convert an input value to the specified type using a custom converter.
TryChangeType<T>(IConverter, object?, T)Attempts to convert an input value to the specified type using a custom converter and invariant culture.
TryChangeType<T>(object?, IFormatProvider?, T)Attempts to convert an input value to the specified type using the default converter.
TryChangeType<T>(object?, T)Attempts to convert an input value to the specified type using the default converter and invariant culture.

ChangeType overloads

ChangeType(IConverter, object?, Type)

ConvertUtilities.cs

Converts an input value to a specified type using a custom converter, or returns null if conversion fails.

public static object? ChangeType(this IConverter converter, object? input, Type conversionType)
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
conversionType Type
The type to convert to.
Returns

object? The converted value if conversion succeeded; otherwise, null.

ChangeType(IConverter, object?, Type, object?)

ConvertUtilities.cs

Converts an input value to a specified type using a custom converter, or returns a default value if conversion fails.

public static object? ChangeType(this IConverter converter, object? input, Type conversionType, object? defaultValue)
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
conversionType Type
The type to convert to.
defaultValue object?
The value to return if conversion fails.
Returns

object? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType(IConverter, object?, Type, object?, IFormatProvider?)

ConvertUtilities.cs

Converts an input value to a specified type using a custom converter, or returns a default value if conversion fails.

public static object? ChangeType(this IConverter converter, object? input, Type conversionType, object? defaultValue, IFormatProvider? provider)
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
conversionType Type
The type to convert to.
defaultValue object?
The value to return if conversion fails.
provider IFormatProvider?
An object that provides culture-specific formatting information.
Returns

object? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType(object?, Type)

ConvertUtilities.cs

Converts an input value to a specified type using the default converter, or returns null if conversion fails.

public static object? ChangeType(object? input, Type conversionType)
Parameters
input object?
The value to convert.
conversionType Type
The type to convert to.
Returns

object? The converted value if conversion succeeded; otherwise, null.

ChangeType(object?, Type, object?)

ConvertUtilities.cs

Converts an input value to a specified type using the default converter, or returns a default value if conversion fails.

public static object? ChangeType(object? input, Type conversionType, object? defaultValue)
Parameters
input object?
The value to convert.
conversionType Type
The type to convert to.
defaultValue object?
The value to return if conversion fails.
Returns

object? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType(object?, Type, object?, IFormatProvider?)

ConvertUtilities.cs

Converts an input value to a specified type using the default converter, or returns a default value if conversion fails.

public static object? ChangeType(object? input, Type conversionType, object? defaultValue, IFormatProvider? provider)
Parameters
input object?
The value to convert.
conversionType Type
The type to convert to.
defaultValue object?
The value to return if conversion fails.
provider IFormatProvider?
An object that provides culture-specific formatting information.
Returns

object? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType<T>(IConverter, object?)

ConvertUtilities.cs

Converts an input value to the specified type using a custom converter, or returns the default value of the type if conversion fails.

public static T? ChangeType<T>(this IConverter converter, object? input)
Type parameters
T
The target type to convert to.
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
Returns

T? The converted value if conversion succeeded; otherwise, the default value of T.

ChangeType<T>(IConverter, object?, T)

ConvertUtilities.cs

Converts an input value to the specified type using a custom converter, or returns a default value if conversion fails.

public static T? ChangeType<T>(this IConverter converter, object? input, T defaultValue)
Type parameters
T
The target type to convert to.
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
defaultValue T
The value to return if conversion fails.
Returns

T? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType<T>(IConverter, object?, T, IFormatProvider?)

ConvertUtilities.cs

Converts an input value to the specified type using a custom converter, or returns a default value if conversion fails.

public static T? ChangeType<T>(this IConverter converter, object? input, T defaultValue, IFormatProvider? provider)
Type parameters
T
The target type to convert to.
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
defaultValue T
The value to return if conversion fails.
provider IFormatProvider?
An object that provides culture-specific formatting information.
Returns

T? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType<T>(object?)

ConvertUtilities.cs

Converts an input value to the specified type using the default converter, or returns the default value of the type if conversion fails.

public static T? ChangeType<T>(object? input)
Type parameters
T
The target type to convert to.
Parameters
input object?
The value to convert.
Returns

T? The converted value if conversion succeeded; otherwise, the default value of T.

ChangeType<T>(object?, T)

ConvertUtilities.cs

Converts an input value to the specified type using the default converter, or returns a default value if conversion fails.

public static T? ChangeType<T>(object? input, T defaultValue)
Type parameters
T
The target type to convert to.
Parameters
input object?
The value to convert.
defaultValue T
The value to return if conversion fails.
Returns

T? The converted value if conversion succeeded; otherwise, defaultValue.

ChangeType<T>(object?, T, IFormatProvider?)

ConvertUtilities.cs

Converts an input value to the specified type using the default converter, or returns a default value if conversion fails.

public static T? ChangeType<T>(object? input, T defaultValue, IFormatProvider? provider)
Type parameters
T
The target type to convert to.
Parameters
input object?
The value to convert.
defaultValue T
The value to return if conversion fails.
provider IFormatProvider?
An object that provides culture-specific formatting information.
Returns

T? The converted value if conversion succeeded; otherwise, defaultValue.

TryChangeType overloads

TryChangeType(IConverter, object?, Type, IFormatProvider?, object?)

ConvertUtilities.cs

Attempts to convert an input value to a specified type using a custom converter.

public static bool TryChangeType(this IConverter converter, object? input, Type conversionType, IFormatProvider? provider, out object? value)
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
conversionType Type
The type to convert to.
provider IFormatProvider?
An object that provides culture-specific formatting information.
value object?
When this method returns, contains the converted value if the conversion succeeded, or null if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType(IConverter, object?, Type, object?)

ConvertUtilities.cs

Attempts to convert an input value to a specified type using a custom converter and invariant culture.

public static bool TryChangeType(this IConverter converter, object? input, Type conversionType, out object? value)
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
conversionType Type
The type to convert to.
value object?
When this method returns, contains the converted value if the conversion succeeded, or null if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType(object?, Type, IFormatProvider?, object?)

ConvertUtilities.cs

Attempts to convert an input value to a specified type using the default converter.

public static bool TryChangeType(object? input, Type conversionType, IFormatProvider? provider, out object? value)
Parameters
input object?
The value to convert.
conversionType Type
The type to convert to.
provider IFormatProvider?
An object that provides culture-specific formatting information.
value object?
When this method returns, contains the converted value if the conversion succeeded, or null if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType(object?, Type, object?)

ConvertUtilities.cs

Attempts to convert an input value to a specified type using the default converter and invariant culture.

public static bool TryChangeType(object? input, Type conversionType, out object? value)
Parameters
input object?
The value to convert.
conversionType Type
The type to convert to.
value object?
When this method returns, contains the converted value if the conversion succeeded, or null if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType<T>(IConverter, object?, IFormatProvider?, T)

ConvertUtilities.cs

Attempts to convert an input value to the specified type using a custom converter.

public static bool TryChangeType<T>(this IConverter converter, object? input, IFormatProvider? provider, out T value)
Type parameters
T
The target type to convert to.
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
provider IFormatProvider?
An object that provides culture-specific formatting information.
value T
When this method returns, contains the converted value if the conversion succeeded, or the default value if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType<T>(IConverter, object?, T)

ConvertUtilities.cs

Attempts to convert an input value to the specified type using a custom converter and invariant culture.

public static bool TryChangeType<T>(this IConverter converter, object? input, out T value)
Type parameters
T
The target type to convert to.
Parameters
converter IConverter
The converter to use for the conversion.
input object?
The value to convert.
value T
When this method returns, contains the converted value if the conversion succeeded, or the default value if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType<T>(object?, IFormatProvider?, T)

ConvertUtilities.cs

Attempts to convert an input value to the specified type using the default converter.

public static bool TryChangeType<T>(object? input, IFormatProvider? provider, out T value)
Type parameters
T
The target type to convert to.
Parameters
input object?
The value to convert.
provider IFormatProvider?
An object that provides culture-specific formatting information.
value T
When this method returns, contains the converted value if the conversion succeeded, or the default value if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.

TryChangeType<T>(object?, T)

ConvertUtilities.cs

Attempts to convert an input value to the specified type using the default converter and invariant culture.

public static bool TryChangeType<T>(object? input, out T value)
Type parameters
T
The target type to convert to.
Parameters
input object?
The value to convert.
value T
When this method returns, contains the converted value if the conversion succeeded, or the default value if the conversion failed.
Returns

bool true if the conversion succeeded; otherwise, false.