Difference between revisions of "Activity:GetPropertyValue (Activity)"
(Created page with "{{ActivityInfoBox | title = Get Property Value | name = GetPropertyValue | image = | imagecaption = Activity GetPropertyValue | purpose = Gets the value of a single property ...") |
|||
| Line 10: | Line 10: | ||
}} | }} | ||
The GetPropertyValue Activity gets the value of a named property of a {{UBIK}} object. | The GetPropertyValue Activity gets the value of a named property of a {{UBIK}} object. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Arguments== | ==Arguments== | ||
| Line 22: | Line 17: | ||
! Argument !! Type !! Direction !! Purpose | ! Argument !! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | Index|| | + | | Index|| {{Integer_MSDN}}|| In || The index of the value of an indexed property; leave empty for a regular value |
|- align="left" | |- align="left" | ||
| − | | PropertyName|| | + | | PropertyName|| {{String_MSDN}}|| In || The name of the property that should be evaluated |
|- align="left" | |- align="left" | ||
| − | | UBIKObject|| BaseClass || In || The object where the property should be evaluated from | + | | UBIKObject|| [[BaseClass]] || In || The object where the property should be evaluated from |
|- align="left" | |- align="left" | ||
| − | | Value|| | + | | Value|| {{Object_MSDN}} || Out|| The returned value |
|- align="left" | |- align="left" | ||
| − | | Result|| | + | | Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed |
|} | |} | ||
Revision as of 14:59, 8 January 2015
| Get Property Value | |
|---|---|
| Name | GetPropertyValue |
| Purpose | Gets the value of a single property |
| Category | Object Primitives |
| Returns | True if successful |
| Version | 2.2+ |
The GetPropertyValue Activity gets the value of a named property of a UBIK® object.
Contents
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| Index | Integer MSDN | In | The index of the value of an indexed property; leave empty for a regular value |
| PropertyName | String | In | The name of the property that should be evaluated |
| UBIKObject | BaseClass | In | The object where the property should be evaluated from |
| Value | Object | Out | The returned value |
| Result | Boolean | Out | True if successful, false if failed |
Usage
This activity is used to read a value of a property of an object, where the property is identified by its name. The value is passed as an OutArgument for further processing.
Example
Get the NAME of a given object:
| Argument | Value |
|---|---|
| UBIKObject | Connect this argument with a variable |
| PropertyName | "NAME" |
