GetBannerLabel method: BannerTile class

Syntax

GetBannerLabel()

Description

Override the GetBannerLabel method to set and return a label for the dashboard header component. Because this label is used for accessibility purposes, never set the label to an empty string.

Note:

The default label is: Dashboard Header.

Important:

Do not explicitly invoke this method. It will be invoked by the PeopleSoft system as necessary.

Parameters

None.

Returns

A string value.

Example

The following implementation of GetBannerLabel overrides the base class implementation.

method GetBannerLabel
   /+ Returns String +/
   /+ Extends/implements PTNUI:Banner:BannerTile.GetBannerLabel +/
   Return "My Dashboard: Contextual Data Area";
end-method;