PropertyCollection class
Represents collection of properties and their values.
Properties
| keys | Get the keys in Property Collection. |
Methods
| clone() | Clones the collection. |
| get |
Returns the property value in type String. Currently only String, int and bool are allowed. If the name is not available, the specified defaultValue is returned. |
| merge |
Merges this set of properties into another, no overwrites. |
| set |
Sets the String value of the parameter specified by name. |
Property Details
keys
Get the keys in Property Collection.
string[] keysProperty Value
string[]
Keys in the collection.
Method Details
clone()
Clones the collection.
function clone(): PropertyCollectionReturns
A copy of the collection.
getProperty(string | PropertyId, string | number | boolean)
Returns the property value in type String. Currently only String, int and bool are allowed. If the name is not available, the specified defaultValue is returned.
function getProperty(key: string | PropertyId, def?: string | number | boolean): stringParameters
- key
-
string | PropertyId
The parameter name.
- def
-
string | number | boolean
The default value which is returned if the parameter is not available in the collection.
Returns
string
value of the parameter.
mergeTo(PropertyCollection)
Merges this set of properties into another, no overwrites.
function mergeTo(destinationCollection: PropertyCollection)Parameters
- destinationCollection
- PropertyCollection
The collection to merge into.
setProperty(string | PropertyId, string)
Sets the String value of the parameter specified by name.
function setProperty(key: string | PropertyId, value: string)Parameters
- key
-
string | PropertyId
The parameter name.
- value
-
string
The value of the parameter.