Class FormatExtensions

Inheritance

System.Object

FormatExtensions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: XBeeLibrary.Core.Models

Assembly: XBeeLibrary.Core.dll

Syntax

public static class FormatExtensions

Methods

Get(Format, String)

Retrieves the Format for the given identifier.

Declaration

public static Format Get(this Format source, string identifier)

Parameters

Type	Name	Description
Format	source
System.String	identifier	ID value to retrieve Format.

Returns

Type	Description
Format	The Format associated with the given identifier, NOFORMAT if it does not exist.

GetAllValues()

Returns all the possible Format values in regex format (separated by '|').

Declaration

public static string GetAllValues()

Returns

Type	Description
System.String	All the possible values in regex format.

GetDescription(Format)

Retrieves the Format description.

Declaration

public static string GetDescription(this Format source)

Parameters

Type	Name	Description
Format	source

Returns

Type	Description
System.String	The format description.

GetIdentifier(Format)

Retrieves the Format identifier.

Declaration

public static Format GetIdentifier(this Format source)

Parameters

Type	Name	Description
Format	source

Returns

Type	Description
Format	The format id.

ToDisplayString(Format)

Returns the Format in string format.

Declaration

public static string ToDisplayString(this Format source)

Parameters

Type	Name	Description
Format	source

Returns

Type	Description
System.String	The Format in string format.