In This Article

IIdProvider Interface

Provides the base requirements for a class that provides ID's.

public interface IIdProvider

Properties

MaxId

Gets the maximum ID returned by this provider.

int MaxId { get; }

Property Value

int:

The maximum ID returned by this provider.

MinId

Gets the minimum ID returned by this provider.

int MinId { get; }

Property Value

int:

The minimum ID returned by this provider.

Methods

ContainsId(int)

Returns whether the specified ID value is valid for this ID provider.

bool ContainsId(int id)
Parameter Type Description
id int

The ID to examine.

Returns

bool:

true if the ID value is valid; otherwise, false

GetDescription(int)

Returns the actual string representation for the specified ID.

string GetDescription(int id)
Parameter Type Description
id int

The ID to examine.

Returns

string:

The actual string representation for the specified ID.

GetKey(int)

Returns the string-based key for the specified ID.

string GetKey(int id)
Parameter Type Description
id int

The ID to examine.

Returns

string:

The string-based key for the specified ID.