Class ValueList

Namespace

SWConfigDataClientLib.Proxies

Assembly

IpPbxCDSClientLib.dll

Named list of ValueItems

[DefaultMember("Item")]
public class ValueList : DictionaryBase

Inheritance

object

DictionaryBase

ValueList

Constructors

ValueList()

standard contructor

public ValueList()

Properties

HasEmpty

Returns true if the ValueList contains an empty element.

public bool HasEmpty { get; set; }

Property Value

bool

this[int]

Gets the ValueItem at index

public ValueItem this[int index] { get; }

Parameters

index int

Position of value in list.

Property Value

ValueItem

ValueItem at given position.

Values

Gets all values(ValueLists)

public SimpleValueList Values { get; }

Property Value

SimpleValueList

Methods

Add(ValueItem)

Adds new value to list

public void Add(ValueItem item)

Parameters

item ValueItem

Add(object)

Adds new value to list

public void Add(object key)

Parameters

key object

key and text of value

Add(object, string, string)

Adds new value to list

public void Add(object key, string text, string description)

Parameters

key object

key of value

text string

text of value

description string

GetName()

retrieves the name of the ValueList

public string GetName()

Returns

string

Name of the ValueList

OnClear()

protected override void OnClear()

OnRemoveComplete(object, object)

protected override void OnRemoveComplete(object key, object value)

Parameters

key object

value object

getDescription(object)

Returns the description of a valueItems in the list. If the value is not in value the method returns an emoty string.

public string getDescription(object key)

Parameters

key object

key of value

Returns

string

getDescriptionByID(int)

Returns the description of a valueItems in the list. If the value is not in value the method returns an emoty string.

public string getDescriptionByID(int iKey)

Parameters

iKey int

Returns

string

getItem(int, int)

public ValueItem getItem(int iSiteID, int iKey)

Parameters

iSiteID int

iKey int

Returns

ValueItem

getItemByID(int)

public ValueItem getItemByID(int iKey)

Parameters

iKey int

Returns

ValueItem

getText(object)

Returns the text of a valueItems in the list. If the value is not in value the method returns an emoty string.

public string getText(object key)

Parameters

key object

key of value

Returns

string

getTextByID(int)

Returns the text of a valueItems in the list. If the value is not in value the method returns an emoty string.

public string getTextByID(int iKey)

Parameters

iKey int

Returns

string