Interface ICustomProperties

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

public interface ICustomProperties

Properties

Count

Gets the number of items in the collection

int Count { get; }

Property Value

int

this[string]

Gets or sets the value of the property with the specified name.

string this[string name] { get; set; }

Parameters

Name	Type	Description
name	string

Property Value

string

Methods

Add(CustomProperty)

Adds a property.

void Add(CustomProperty item)

Parameters

Name	Type	Description
item	CustomProperty	The property to add.

Add(string, string)

Adds or updates the property with the specified name.

CustomProperty Add(string name, string value)

Parameters

Name	Type	Description
name	string
value	string

Returns

CustomProperty

Remarks

See Name for requirements for the name.

Clear(string)

Removes all properties whose names start with the specified prefix.

void Clear(string prefix)

Parameters

Name	Type	Description
prefix	string

ContainsKey(string)

Determines whether the collection contains a property with the specified name.

bool ContainsKey(string name)

Parameters

Name	Type	Description
name	string

Returns

bool

GetByPrefix(string)

Gets all properties whose name starts with the specified prefix.

IEnumerable<CustomProperty> GetByPrefix(string prefix)

Parameters

Name	Type	Description
prefix	string

Returns

IEnumerable<CustomProperty>

GetProperty(int)

Gets the property at the specified index;

CustomProperty GetProperty(int index)

Parameters

Name	Type	Description
index	int	The zero-based index of the property to get.

Returns

CustomProperty

The property at the requested index. Throws an exception if the index is not valid.

Remarks

Adding or updating properties in this collection only affects the job instance in which the script is running.

GetProperty(string)

Gets the property at the specified index;

CustomProperty GetProperty(string name)

Parameters

Name	Type	Description
name	string	The name (case-insensitive) of the property to get.

Returns

CustomProperty

The requested property, or null if no property exists with that name.

Remove(CustomProperty)

Removes the specified property

void Remove(CustomProperty property)

Parameters

Name	Type	Description
property	CustomProperty

Remove(string)

Removes the property with the specified name.

void Remove(string name)

Parameters

Name	Type	Description
name	string

Extension Methods

• StringUtil.ListToString<T>(IEnumerable<T>, string)