Banner Class Methods
In this section, the Banner class methods are presented in alphabetical order.
Syntax
ClearConfirmation()
Description
Use the ClearConfirmation method to dismiss the transient confirmation message (to ensure that the message is dismissed even if auto dismiss is disabled through the user's preference settings).
Parameters
None
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).ClearConfirmation();
Syntax
GetFixedPageTitleField()
Description
Use the GetFixedPageTitleField method to instantiate a Field object representing the page title found in the fluid banner for a component currently executing in a search context.
Important! Use this method only when you have implemented a custom search page for this component. This method is not needed when the standard PeopleTools-delivered search page is used.
Parameters
None
Returns
A Field object.
Example
Local Field &oSearchPageTitle = (create PT_PAGE_UTILS:Banner()).GetFixedPageTitleField();
Syntax
GetPageTitleField()
Description
Use the GetPageTitleField method to instantiate a Field object representing the page title found in the fluid banner (if available).
This method is ignored and has no effect if the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: This method typically is not used, but is available if additional manipulation of the page title field is required.
Parameters
None
Returns
A Field object.
Example
Local Field &oTitle = (create PT_PAGE_UTILS:Banner()).GetPageTitleField();
Syntax
SetConfirmationMessage(MessageText)
Description
Use the SetConfirmationMessage method to display a typically transient confirmation message below the fluid banner.
Parameters
Field or Control |
Definition |
---|---|
MessageText |
Specifies the message text as a String value. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetConfirmationMessage("Your operation was successful.");
Syntax
SetFixedPageTitle(Title)
Description
Use the SetFixedPageTitle method to set the page title while in search context. Use this method on a custom search page only.
Parameters
Field or Control |
Definition |
---|---|
Title |
Specifies the page title as a String value. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetFixedPageTitle("My Search Page Title");
Syntax
SetPageTitle(Title)
Description
Use the SetPageTitle method to set the page title in the fluid banner.
This method is ignored and has no effect if the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Parameters
Field or Control |
Definition |
---|---|
Title |
Specifies the page title as a String value. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetPageTitle("My Title");
Syntax
SetVisibilityActionList(Visible)
Description
Use the SetVisibilityActionList method to set the visibility of the Actions menu in the fluid banner. This method is ignored and has no effect if the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the Actions menu is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityActionList( False);
Syntax
SetVisibilityAddto(Visible)
Description
Use the SetVisibilityAddto method to set the visibility of the Add To feature in the fluid banner (or Actions menu). This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If the user does not have permission to perform the action or access the target.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the Add To feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityAddto( False);
Syntax
SetVisibilityHelp(Visible)
Description
Use the SetVisibilityHelp method to set the visibility of the Help feature in the Actions menu. This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If Help is not configured on this system.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the Help feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityHelp( False);
Syntax
SetVisibilityHome(Visible)
Description
Use the SetVisibilityHome method to set the visibility of the Home feature in the fluid banner (or Actions menu). This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If the user does not have permission to perform the action or access the target.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the Home feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityHome( False);
Syntax
SetVisibilityMyPreferences(Visible)
Description
Use the SetVisibilityMyPreferences method to set the visibility of the My Preferences link in the Actions menu. This method is ignored and has no effect in any of the following conditions:
If the user does not have permission to perform the action or access the target.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the My Preferences link is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityMyPreferences( False);
Syntax
SetVisibilityNavbar(Visible)
Description
Use the SetVisibilityNavbar method to set the visibility of the NavBar feature in the fluid banner (or Actions menu). This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If the user does not have permission to perform the action or access the target.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the NavBar feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityNavbar( False);
Syntax
SetVisibilityNotifications(Visible)
Description
Use the SetVisibilityNotifications method to set the visibility of the Notifications feature in the fluid banner (or Actions menu). This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If the user does not have permission to perform the action or access the target.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the Notifications feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilityNotifications( False);
Syntax
SetVisibilitySearch(Visible)
Description
Use the SetVisibilitySearch method to set the visibility of the Search feature in the fluid banner (or Actions menu). This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If Search is not configured on this system.
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visible |
Specifies a Boolean value indicating whether the Search feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilitySearch( False);
Syntax
SetVisibilitySignout(Visible)
Description
Use the SetVisibilitySignout method to set the visibility of the Sign Out feature in the Actions menu. This method is ignored and has no effect in any of the following conditions:
If the feature is disabled in the component’s properties (Fluid tab).
If the component is rendered in a context that does not allow access to the fluid banner and Actions menu (that is, in an activity guide, in a modal window or in a modeless window, when executing as a grouplet request, or when executing as a component interface).
Note: Because the PT_HEADERPAGE page also performs an operation equivalent to this method in its page Activate event, you should invoke this method after that event to ensure that your changes are not overwritten.
Parameters
Field or Control |
Definition |
---|---|
Visibe |
Specifies a Boolean value indicating whether the Sign Out feature is visible. |
Returns
None
Example
(create PT_PAGE_UTILS:Banner()).SetVisibilitySignout( False);