BannerTile Class Properties

In this section, the BannerTile class properties are presented in alphabetical order.

Description

Use the AnnounceText property to set or return a string value representing an announcement to be posted to an ARIA (Accessible Rich Internet Applications) live region of the page when the tiles have been updated with new context values—for example, after UpdateContext has been invoked. This announcement is available to be read by screen readers and other assistive technologies.

Set this property in the constructor method of your custom application class.

Note: There is no default value; you must specify the announcement text.

This property is read/write.

Example

%This.AnnounceText = "One or more tiles has been updated.";

Description

Use the HomepageId property to return a string value representing the concatenation of the following values: NODE_NAME.PORTAL_NAME.HOMEPAGE_NAME For example:

QEDMO.EMPLOYEE.MY_CONTEXT_DB

This property is read-only.

Description

Use the HomepageName property to return a string value representing the homepage ID that was specified by the &homepage_ID parameter when an object of your custom application class was instantiated in the dashboard header page’s Activate event. This value, returned by the Request object, represents the content reference name for the fluid dashboard definition. For example:

MY_CONTEXT_DB

This property is read-only.

Description

Use the IsPersistContext property to set or return a boolean value indicating whether the context keys and values are persisted in memory throughout the user's session. Set this property in the constructor method of your custom application class. If IsPersistContext is set to False, the default context keys and values as specified by SetDefaultContext are still propagated to the tiles on the dashboard. However, these keys and values are not retained in memory.

Note: The default value is True.

This property is read/write.

Example

%This.IsPersistContext = False;

Description

Use the KeyVals property to return an array of array of string representing the current context keys and key values. For example, KeyVals [1][1] represents the first context key, and KeyVals [1][2] represents the corresponding key value.

This property is read-only.

Example

For example, the GetContextString method returns the following context string:

SETID=DFLTSET

Then, KeyVals [1][1] equals SETID, and KeyVals [1][2] equals DFLTSET.

Description

Use the NodeName property to return a string value representing the node name for the current node.

This property is read-only.

Description

Use the PortalName property to return a string value representing the node name for the current node.

This property is read-only.