NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

Enum.Format ()

Converts the current value of this enumeration to human readable format.

[Visual Basic]
Overloads Public Function Format() As String
[C#]
public string Format();
[C++]
public: String* Format();
[JScript]
public function Format() : String;

Return Value

The current value in human readable format.

Remarks

For PASCAL style enums who's value maps directly the name of the field is returned. For PASCAL style enums who's values do not map directly the decimal value of the field is returned. For BitFlags (indicated by the Flags custom attribute): If for each bit that is set in the value there is a corresponding constant (a pure power of 2), then the OR string (ie "Red | Yellow") is returned. Otherwise, if the value is zero or if you can't create a string that consists of pure powers of 2 OR-ed together, you return a hex value (without the leading "Ox"). That is for example: "000000003".

See Also

Enum Class | Enum Members | System Namespace | Enum.Format Overload List