_x_getBagString()

The _x_getBagString() function returns a string value from a property bag, or an optional default value.

UJML Script Syntax

string _x_getBagString(string bagName, int key [, string default])

Parameters

Parameters	Description
bagName	The name of a loaded property bag. See _x_loadBag() function.
key	An int expression or value representing the key of the item.
default	A string expression or value to use as a default if the key does not exist (not required).

Returns

The _x_getBagString() function returns a string value from a property bag, or an optional default value.

Description

This function retrieves a string value with the referenced key from the named property bag. See Property Bag Functions. If the key does not exist it returns either an empty string ("") or the optional default value.

Example

The following example shows how to get values from a property bag. It is part of the visualelements.ujml sample.

Copy Code

mSingleLineText =
    _x_getBagString("&BAG_NAME;", &BAG_LABEL_TEXT;, mDefaultLabelText);
mMultiLineText =
    _x_getBagString("&BAG_NAME;", &BAG_MULTI_LABEL_TEXT;, mDefaultMultiLabelText);