(Display Manager Library)
| Description: | Returns the index of the caller's display instance. |
| Returns: | Numeric |
Usage:  |
Script Only. |
| Function Groups: | Graphics |
| Related to: | |
| Format: |
\DisplayManager.GetDisplayIndex([Context]) |
| Parameters: |
| Context |
| Optional. Module instance whose display instance’s index needs to be returned. If not provided, it represents the module instance which is calling this API. |
| Comments: |
In a multi-monitor setup, the layout of the monitor indexes is straightforward. For example, a 3x2 grid of monitors is indexed as: [1][2][3] [4][5][6] The primary purpose of using this API is to get the index of the display instance belonging to the specific monitor when the application is running in a multi-monitor setup. If this API is called from a single-monitor setup(not a multi-monitor), then it will always return index number 1 as there will always be a single display instance. If called by a popup page, the display index of the popup page's root page will be returned.
|
Example:
To fetch the index of the current module's display instance
DisplayIndex = \DisplayManager.GetDisplayIndex(Self);
or
DisplayIndex = \DisplayManager.GetDisplayIndex();
