Built-In Functions

This table lists the PeopleCode built-in functions provided for use with fluid applications at the component or page level.

Function	Description
PeopleCode Language Reference: AddJavaScript function	Add JavaScript to the document or page.
PeopleCode Language Reference: AddMetaTag function	Add a meta tag to the document or page.
PeopleCode Language Reference: AddOnLoadScript function	Add the script to run in the onload event of the document.
PeopleCode Language Reference: AddStyleSheet function	Add a free form style sheet to the HTML document for the page or component.
PeopleCode Language Reference: CreateSearchRowset function	Create the rowset based of the search record and key list values.
PeopleCode Language Reference: DoModalComponentPopup function	Display a secondary fluid component in a modal, secondary window with a child relationship to the parent window. See Transfer and Modal Functions for a complete list of functions available for implementing transfers and creating modal windows.
PeopleCode Language Reference: DoModalPopup function	Display a secondary fluid page in a modal, secondary window with a child relationship to the parent window. See Transfer and Modal Functions for a complete list of functions available for implementing transfers and creating modal windows.
PeopleCode Language Reference: ExecuteSearchSavePC function	Run the SearchSave PeopleCode on the search page.
PeopleCode Language Reference: GetAddSearchRecName function	Return the add search/prompt record name.
PeopleCode Language Reference: GetComponentTitle function	Return the name of the component (from the component definition).
PeopleCode Language Reference: GetPagePrefix function	Return the prefix for the page based on the page type as set on the Use tab.
PeopleCode Language Reference: GetPageTitle function	Return the title of the page.
PeopleCode Language Reference: GetPageType function	Return the page type—for example, header, footer, prompt, and so on.
PeopleCode Language Reference: GetPanelControlStyle function	Return the styles set by the system that control the state of the left and right panels.
PeopleCode Language Reference: GetSearchRecordName function	Return the search/prompt record name.
PeopleCode Language Reference: GroupletRequestSource function	Return an Integer value indicating the source page (location) for the grouplet.
PeopleCode Language Reference: IsAddEnabled function	Return a boolean value indicating whether Add mode has been enabled on the component's Use tab.
PeopleCode Language Reference: IsAddMode function	Return a boolean value indicating whether the component build process is in add mode.
PeopleCode Language Reference: IsAGComponent function	Return a boolean value indicating whether the component type is set to Activity Guide on the Fluid tab.
PeopleCode Language Reference: IsAGRequest function	Return a boolean value indicating whether the request was initiated by an activity guide wrapper.
PeopleCode Language Reference: IsBackEnabled function	Return a boolean value indicating whether back navigation is enabled on the component.
PeopleCode Language Reference: IsFluidMode function	Return a boolean value indicating whether Fluid Mode is enabled on the component.
PeopleCode Language Reference: IsFluidSearchStart function	Return a boolean value indicating whether the Fluid Search is started on the component.
PeopleCode Language Reference: IsGroupletRequest function	Return a boolean value indicating whether the request was initiated by a tile (also referred to as a grouplet).
PeopleCode Language Reference: IsHomeEnabled function	Return a boolean value indicating whether the Home button is enabled on the component.
PeopleCode Language Reference: IsIScriptAuthorized function	Return a boolean value indicating whether the current user is allowed to access the specified iScript.
PeopleCode Language Reference: IsLogoutEnabled function	Return a boolean value indicating whether Logout is enabled on the component.
PeopleCode Language Reference: IsMDComponent function	Return a boolean value indicating whether the component type is set to Master/Detail on the Fluid tab.
PeopleCode Language Reference: IsMDGuided function	Return a boolean value indicating whether the master/detail or activity guide wrapper is in guided mode (that is, Previous and Next are displayed in the fluid banner).
PeopleCode Language Reference: IsMDListPopup function	Return a boolean value whether the master/detail or activity guide wrapper is in non-optimized mode (that is, navigation to pages is presented in a drop-down list in the fluid banner, not in the left panel).
PeopleCode Language Reference: IsMDNonOptimized function	This function is equivalent to the IsMDListPopup function.
PeopleCode Language Reference: IsMDRequest function	Return a boolean value indicating whether the request was initiated by a component from within the master/detail wrapper.
PeopleCode Language Reference: IsMDSearchEnabled function	Return a boolean value indicating whether the search type is set to Master/Detail for the current component.
PeopleCode Language Reference: IsModeless function	Return a boolean value indicating whether the target content for the tile is currently being displayed in a modal window—that is, the Display In setting for the tile is set to Modal.
PeopleCode Language Reference: IsNavBarEnabled function	Return a boolean value indicating whether the NavBar is enabled on the component.
PeopleCode Language Reference: IsNextInListEnabled function	Return a boolean value indicating whether NextInList is enabled on the component.
PeopleCode Language Reference: IsNotificationEnabled function	Return a boolean value indicating whether the Notifications button is enabled on the fluid component. This corresponds to the Notifications toolbar option on the component’s Fluid tab.
PeopleCode Language Reference: IsPinEnabled function	Return a boolean value indicating whether the Add To functions are enabled on the component.
PeopleCode Language Reference: IsPrevInListEnabled function	Return a boolean value indicating whether PreviousInList is enabled on the component.
PeopleCode Language Reference: IsSaveEnabled function	Return a boolean value indicating whether Save is enabled on the component.
PeopleCode Language Reference: IsSearchEnabled function	Important: In PeopleTools 8.55 or later, use either the IsMDSearchEnabled function or the IsStandardSearchEnabled function instead to determine which type of search is enabled. Return a boolean value indicating whether search is enabled on the component.
PeopleCode Language Reference: IsSingleComponentAG function	Return a boolean value indicating whether this is a single component activity guide.
PeopleCode Language Reference: IsSingleUnitOfWork function	Return a boolean value indicating whether this is a single unit of work activity guide.
PeopleCode Language Reference: IsSmallFFOptimized function	Return a boolean value indicating whether the Display on Small Form Factor Homepage option has been selected on the Fluid tab of the component properties.
PeopleCode Language Reference: IsStandardSearchEnabled function	Return a boolean value indicating whether the search type is set to Standard for the current component.
PeopleCode Language Reference: SetAddMode function	Set the AddMode attribute in the panel processor.
PeopleCode Language Reference: SetMDGuided function	Set whether the master/detail or activity guide wrapper is in guided mode (that is, Previous and Next buttons are displayed in the fluid banner).
PeopleCode Language Reference: SetMDListPopup function	Set whether the master/detail or activity guide wrapper is in non-optimized mode (that is, navigation to pages is presented in a drop-down list in the fluid banner, not in the left panel).
PeopleCode Language Reference: SetPanelControlStyle function	Specify a String value that updates the system with styles that control the state of the left and right panels.
PeopleCode Language Reference: SetThemeId function	Set the theme ID for the page so that proper theme style sheets get loaded.
PeopleCode Language Reference: SetTransferAttributes function	Set certain fluid-related properties prior to transferring to a different page or component.