EnumExtensionsToStringTEnum(TEnum, EnumFormattingOptions, String) Method

Returns the String representation of the given enum value specified in the value parameter.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 8.1.0
C#
public static string ToString<TEnum>(
	this TEnum value,
	EnumFormattingOptions format = EnumFormattingOptions.Auto,
	string? separator = ", "
)
where TEnum : struct, new()

Parameters

value  TEnum
An value that has to be converted to String.
format  EnumFormattingOptions  (Optional)
Formatting option. This parameter is optional.
Default value: Auto.
separator  String  (Optional)
Separator in case of flags formatting. If or is empty, then comma-space (, ) separator is used. This parameter is optional.
Default value: , .

Type Parameters

TEnum
The type of the enum value.

Return Value

String
The string representation of value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type TEnum. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

See Also