Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Frame - property of object PmViewCreator

Description:
Returns the PmMap object that contains parameters for the frame where the viewer will be displayed.
Syntax:
PmMap Frame
Calling:
oFrame = oCreator.Frame
Note:
Property access for read only. But it is possible to write into the properties of the PmMap object and it is also possible to add new properties of this object.
 
The parameters differ for various frame types. There are 3 frame types:
- independent window (target:_blank;)
- frame in the workspace (in the PmaWorkspace object)
- the graphic object PmgFrame
 
The parameters are in the form of the PmMap object that is filled from value of the sFrame parameter (of the KeyVal type) in the Pm.CreateView method.

By filling from the KeyVal value all the parameters are initially stored as string. The content of the PmMap object can be then modified as needed - the items can be modified, added and deleted.

The PmMap object can also contain other embedded PmMap objects (Submap). The PmMap.mapSetSubmapAt method can be used in order to create a new PmMap or make one accessible.

 

Common parameters for all frame types:

target:xx; - Specifies in which frame will viewer be opened.
If not set, then the following settings are used as default:
- if the window is open as modal (is set "1"), then "_blank" is set.
- if is opened from object PmaPanel, then "_self" is set.
- if is opened from object PmaWorkspace, then the main frame identifier in this workspace is used (defined in the "Default frame" configurator).
- if is opened from object PmgFrame, then the viewer displays in the PmgFrame object).
frameid - The new viewer is opened in the PmaWorkspace object in frame with frameid identifier.
_blank - The new viewer is opened in a new window.
_blank.blankid - If there is a window with blankid identifier then the new viewer opens in current window, otherwise it opens in a new window. This prevents opening too many windows.
_self - The new viewer is opened in the current window (frame) and the viewer, over which the method was called, is closed.
scrollbar:nn; - Specifies whether the window will have the scrollbars for moving the contents, if the panel size is greater than the size of the window, the panel is inside.
0 - The scrollbars will never be displayed and therefore the window content cannot be scrolled. It is handy for example for very narrow "toolbar" type windows.
1 (default) - The window displays the scrollbars thus allwing to scroll the panel, if the panel size is greater than the size of the window, the panel is inside.
refresh:xx; - Only for opening the viewer of the PmaPanel object. Specifies whether the panel has the automatic refresh according to the globally set system period or the panel has its own refresh rate. So far it is not functional when opening Web panel.
0 - The panel will have its own refresh, i.e. the PmaPanel.Refresh method will be called.
system (default) - The panel will have the automatic refresh according to the globally set system period (See PmaRoot > Application > Panels timer period).

Parameters only for a frame in an independent window:

modal:nn; - Specifies whether the window will be modal.
0 (default) - The window will not be modal.
1 - The window will be modal.
dependent:nn; - Specifies whether the window will be dependend on the application main window.
0 - The window will be independent on the application main window. So far it is not functional when opening Web panel.
1 (default) - The window will be dependent on the application main window and will always be on top of the application.
caption:nn; - Specifies whether the window has the header or not (i.e. the blue stripe on top).
0 - The window will have no header. So far it is not functional when opening Web panel.
1 (default) - The window will have the header.
ontop:nn; - Specifies whether the window will be "Always on top".
0 (default) - The window will not be "Always on top".
1 - The window will be "Always on top". So far it is not functional when opening Web panel.
state:xx; - Specifies the initial state of the window.
normal (default) - The window will be displayed normally (neither maximalized nor minimalized).
max - The window will be maximalized. So far it is not functional when opening Web panel.
pos:xx; - Specifies the initial position of the window in normal state.

This position is just recommended. If the window size does not fit into the screen, then the position is shifted so the biggest possible portion of the window is visible.

top,center (default) - The window will be displayed in the center of the active application window (workspace).
top,x,y - The window will have the top left corner in coordinates x and y (in pixels) relative to the active application window (workspace).
frame,center - The window will be displayed in the center of the window from which the new window was opened.
view,x,y - The window will have the top left corner in coordinates x and y (in pixels) relative to content of the window from which it is opened.

The position is set as relative to window content (view) and not to the window itself (frame). This way it is possible for example to place the new window aside from the Pmg object the window was opened from. See The example of window opening and placing according to the Pmg object position.

screen,x,y - The window will have the top left corner in coordinates x and y (in pixels) in Windows absolute grid system. This option is not functional on web. It can be used for positioning ing main windows (PmaWorkspace or PmaPanel) of the application to individual displays. Other application windows are then usually positioned relatively to these main windows.
size:xx; - Specifies the initial size of the window in normal state.
panel (default) - The size of the window will be set in order to contain the whole opened panel (i.e. no scrollbars are created). Width and height of the panel is entered in the graphics editor in the PmgRoot object on the "Panel" page.
dx,dy - The size of the window will be defined by the dx and dy values (in pixels). These values define the outer size of the window (i.e. including the margins and window title bar).
fixed:xx,yy,..; - It allows to disable the change of state, position or panel size. It is defined as a list of prohibitions separated by "comma" (,). So far it is not functional when opening Web panel. The default value is: everything is enabled.
state - Forbids to change the window state (normal / maximized / minimized).
pos - Forbids to change the position of the window in normal state.
size - Forbids to change the size of the window in normal state.
size2 - Disables changing the size of the window in normal state - the window size cannot be greater than the size of corresponding panel.
See also:

History:
Pm9.00.09: Created
PROMOTIC 9.0.9 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice