CapyKit/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

1.8 KiB

GetPrettyName Method

An Enum extension method that gets a human readable name.

Definition

Namespace: CapyKit.Extensions
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0

C#

public static string GetPrettyName(
	this Enum enumeration
)

F#

[<ExtensionAttribute>]
static member GetPrettyName : 
        enumeration : Enum -> string 

Parameters

  Enum
The enumeration to act on.

Return Value

String
The human readable name of the enumeration.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. 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).

See Also

Reference

EnumerationExtensions Class
CapyKit.Extensions Namespace