Changes
Created page with "{{ActivityInfoBox | title = Set Property Value | name = SetPropertyValue | image = | imagecaption = Activity SetPropertyValue | purpose = Set the value of a single property |..."
{{ActivityInfoBox
| title = Set Property Value
| name = SetPropertyValue
| image =
| imagecaption = Activity SetPropertyValue
| purpose = Set the value of a single property
| category = Object Primitives
| returns = True if successful
| version = 2.1+
}}
The SetPropertyValue Activity sets the named property of a {{UBIK}} object to a certain value.
==Arguments==
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| UBIKObject|| BaseClass || In || The object where the property should be set
|- align="left"
| PropertyName|| String|| In || The name of the property that should be set
|- align="left"
| Value|| Object || In || The new value that should be stored in the property
|- align="left"
| Result|| Boolean|| Out || True if successful, false if failed
|}
==Usage==
This activity is used to set a property of an object to a new value, where the property is identified by its name. This is typically necessary when you created a new object during the workflow, e.g. with the [[CreateInstance (Activity)|CreateInstance activity]], or if you want to modify existing objects.
{{Attention|This activity does not automatically save changes. If you want to persist the changed values, you need i.e. a subsequent [[SaveObject (Activity)|SaveObject activity]]!}}
==Example==
Set the ''NAME'' of a given object to the new value "NewName":
{| class="wikitable" | width = "50%"
|-
! Argument!! Value
|- align="left"
| UBIKObject|| Connect this argument with a variable
|- align="left"
| PropertyName || <source lang = "vbnet">"NAME"</source>
|- align="left"
| Value || <source lang = "vbnet">"NewName"</source>
|}
==See also==
* [[Workflow Designer]]
* [[CreateInstance (Activity)]]
[[Category:Workflows]] [[Category:Activities]]
| title = Set Property Value
| name = SetPropertyValue
| image =
| imagecaption = Activity SetPropertyValue
| purpose = Set the value of a single property
| category = Object Primitives
| returns = True if successful
| version = 2.1+
}}
The SetPropertyValue Activity sets the named property of a {{UBIK}} object to a certain value.
==Arguments==
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| UBIKObject|| BaseClass || In || The object where the property should be set
|- align="left"
| PropertyName|| String|| In || The name of the property that should be set
|- align="left"
| Value|| Object || In || The new value that should be stored in the property
|- align="left"
| Result|| Boolean|| Out || True if successful, false if failed
|}
==Usage==
This activity is used to set a property of an object to a new value, where the property is identified by its name. This is typically necessary when you created a new object during the workflow, e.g. with the [[CreateInstance (Activity)|CreateInstance activity]], or if you want to modify existing objects.
{{Attention|This activity does not automatically save changes. If you want to persist the changed values, you need i.e. a subsequent [[SaveObject (Activity)|SaveObject activity]]!}}
==Example==
Set the ''NAME'' of a given object to the new value "NewName":
{| class="wikitable" | width = "50%"
|-
! Argument!! Value
|- align="left"
| UBIKObject|| Connect this argument with a variable
|- align="left"
| PropertyName || <source lang = "vbnet">"NAME"</source>
|- align="left"
| Value || <source lang = "vbnet">"NewName"</source>
|}
==See also==
* [[Workflow Designer]]
* [[CreateInstance (Activity)]]
[[Category:Workflows]] [[Category:Activities]]
