Properties

Static Methods

getProperties

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Properties

Return Property Owner Object

Parameters

Name
Type
Description
propertyOwnerObject
Project or Sequence
This can also be object instance of Project, Sequence etc..

Instance Methods

createClearValueAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

Create an action to clear the value with the given name. This method can fail if e.g. the underlying properties object does not support action based setting of properties.

Parameters

Name
Type
Description
name
string
-

createSetValueAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

Create an action to set a named value through scripting. The parameters are <name, value (number, boolean or string), persistence flag>. This method can fail if e.g. the underlying properties object does not support action based setting of properties.

Parameters

Name
Type
Description
name
string
property name
value
boolean or string or number
Value to set for the property key
persistenceFlag
Constants.PropertyType
Indicates whether the property should be persisted or not

getValue

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

string

Get named value in native string form

Parameters

Name
Type
Description
name
string
-

getValueAsBool

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

boolean

Get named value as boolean

Parameters

Name
Type
Description
name
string
-

getValueAsFloat

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

number

Get named value as float number

Parameters

Name
Type
Description
name
string
-

getValueAsInt

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

number

Get named value as integer number

Parameters

Name
Type
Description
name
string
-

hasValue

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

boolean

Check if a named value exists under this name.

Parameters

Name
Type
Description
name
string
-