Map Class Properties
In this section, the Map class properties are presented in alphabetical order.
Description
Use this property to return a String representing browser device type in use by the user signed onto the MAP application.
The values can be one of the following constants:
%MAP_Desktop
%MAP_Phone
%MAP_Tablet
This property is read-only.
Example
If &Map.BrowserDeviceType = %MAP_Phone Then
...Description
Use this property to return a String representing browser platform (operating system) in use by the user signed onto the MAP application.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the <canvas> element.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the DatePicker widget.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device natively supports drag-and-drop.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the DateTimePicker widget.
This property is read-only.
Description
Use this property to return an Integer value representing whether the device supports geolocation:
0 - The device does not support geolocation.
1 - The device supports geolocation.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports a high contrast mode.
This property is read-only.
Description
Use this property to return an Integer value representing the device's height in physical pixels.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the history API.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the localStorage object.
This property is read-only.
Description
Use this property to return an Integer value representing the ratio between physical pixels and device-independent pixels (dips) on the device.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the window.postMessage method.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the sessionStorage object.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the Scalable Vector Graphics (SVG) format.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the TimePicker widget.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports touch events.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the WebSockets API.
This property is read-only.
Description
Use this property to return a Boolean value indicating whether the device supports the Web Workers API.
This property is read-only.
Description
Use this property to return an Integer value representing the device's width in physical pixels.
This property is read-only.
Description
Use the ExceptionLayoutName property to return the name of the exception layout as a string value.
This property is read-only.
Description
Use the IsIBBaseDomain property to return a boolean value indicating whether the domain of the MAP application is the same as the base domain used by Integration Broker.
This property is read-only.
Description
Use this property to return a String representing the name of the MAP layout.
This property is read-only.
Description
When an exception is thrown, use the MAPException property to return the exception for this MAP layout as an Exception object.
This property is read-only.
Description
Use the MAPURL property to set or return a URL to this MAP application, which can be used to set the destination for the Back button.
This property is read/write.
Description
Use the NoBackButtonUpdate property to set or return a boolean value indicating whether to update the Back button. When this property is set to True, the current URL defined for the Back button will not be updated with the URL that invoked this MAP application.
This property is read/write.
Description
Use the PIAOriginLabel property to return a String representing the label to be used on the Back button for returning to the calling PeopleSoft application (classic, fluid, or MAP).
This property is read-only.
Description
Use the PIAOriginURL property return a String representing the URL that will be invoked to return to the PeopleSoft application (classic, fluid, or MAP) that called the current MAP application.
This property is read-only.
Description
Use the PSBackLabel property to set or return a String representing the label to be used on the Back button for returning to the previous page (or application).
Note: When a MAP application is first accessed from another PeopleSoft application (classic, fluid, or MAP), the value of PSBackLabel and PIAOriginLabel will be the same.
This property is read/write.
Example
In the following example, the label text for the back button in the application is set to the value of the PSBackLabel property:
&Map.GetElement("map_back_button").LabelText = &Map.PSBackLabel;Description
Use the PSBackOrigin property to return a String representing the type of PeopleSoft application that called the current MAP application.
The values can be one of the following constants:
%MAP_Back_MAP
%MAP_Back_PIA
This property is read-only.
Description
Use the PSBackURL property return a String representing the URL that will be invoked to return to the previous page--that is, the page that called the current MAP application page.
Note: When a MAP application is first accessed from another PeopleSoft application (classic, fluid, or MAP), the value of PSBackURL and PIAOriginURL will be the same.
This property is read-only.
Description
Use the RAClass property to set or return a String representing the class name to apply to related actions for this MAP application.
This property is read/write.
Description
Use the RAImage property to set or return a String representing the image to use to indicate that there are related actions for this MAP application.
This property is read/write.
Description
Use the RAPopupClass property to set or return a String representing the class name to apply to the related actions popup for this MAP application.
This property is read/write.
Description
Use the RAStyle property to set or return a String representing the style name to apply to related actions for this MAP application.
This property is read/write.
Description
Use this property to return a String specifying the PeopleSoft node for the authentication token.
This property is read-only.
Description
Use the SecureRequest property to return a boolean value indicating whether the request is a secure request—that is, made via https. If the value of this property is False, the request was made via http.
This property is read-only.
Description
Use this property to return a Boolean indicating whether state is being maintained for this MAP application.
The MAP framework automatically generates and saves the state ID for a layout when the “Retain State” check box has been selected in the Layout Details group box of the Layout page.
This property is read-only.
Description
Use this property to set or return a String representing the current state ID for the MAP application.
The MAP framework automatically generates and saves the state ID for a layout when the “Retain State” check box has been selected in the Layout Details group box of the Layout page.
The state can also be specified as the %MAP_State_No_Update constant, which indicates that the state will not be updated for this event.
This property is read/write.
Description
Use this property to return a Boolean value indicating whether the state has been retrieved and loaded.
This property is read-only.
Description
Use this property to set or return an Integer representing the status of the MAP application.
The values can be one of the following constants:
%MAP_Development
%MAP_Production
This property is read/write.
Description
Use this property to set or return a String representing title for the MAP application to be displayed in the browser’s title bar. The default is the name of the MAP layout.
This property is read/write.
Description
Use this property to return an Integer representing which set of initialization parameters were used to invoke the MAP application.
This property is read-only.
Description
Use this property to set or return an Integer representing the type of form validation to be performed for this MAP application.
The values can be one of the following constants:
%MAP_Validate
%MAP_No_Validate
%MAP_Validate_Custom
This property is read/write.