Promotic

Setting of the sFramePars default values - configuration window

Description:
The parameters transferred to the viewer. These define where and how to open the viewer.
Entries are in the KeyVal format, for example "target:_blank;modal:1;".

It is a static default setting of entries.
The entries can also be defined dynamically at viewer opening (see the sOptions parameter in the OpenView method). In this case the static default setting of the object is combined with the entries provided dynamically. If the same information is present on both places, then the dynamical information provided at viewer opening is preferred by the system.

This configuration window can be opened in the "PmaPanel > Panel > sFramePars default value" configurator.
Configurators:
This configuration is for:Here it is possible to select the desired default window type (the way the panel will be displayed). According to this setting, additional configurators become visible/invisible. This configurator does not affect the resulting values, it only makes the configurators easier to fill in.
Window in the frame of the PmaWorkspace object or in the Pmg object - The panel is used
for displaying either in the PmaWorkspace object (see the PmaPanel.OpenView method) or
for displaying in the PmgFrame object (see the PmgFrame.Src property).
Stand-alone or modal window - The panel is used for displaying in the form of independent or modal window
Where to open the window (target)Specifies in which frame will viewer be opened. This configurator is visible only if the configuration is for: "Window in the frame of the PmaWorkspace object or in the Pmg object".
frameid - The new viewer is opened in the PmaWorkspace object in the frame with frameid identifier.
_blank - The new viewer is opened in a new window.
_self - The new viewer is opened in the current window (in the frame) and the viewer, over which the method was called, is closed.
Identifier of the window (blankid)Identifier of the independent or modal window. If a window with blankid identifier already exists then the new viewer opens in current window, otherwise it opens in a new window. This prevents opening too many windows.
This is a system name, so it must contain only alphanumeric and must not contain any diacritics, spaces and the first character must not be a number..
Modal window (modal)Specifies whether the window will be modal. This configurator is visible only if the configuration is for: "Stand-alone or modal window".
0 - No (default) - The window will not be modal.
1 - Yes - The window will be modal.
Caption enabled (caption)Specifies whether the window has the window title bar or not (i.e. the blue stripe on up). This configurator is visible only if the configuration is for: "Stand-alone or modal window".
0 - No - The window will have no title bar. So far it is not functional when opening Web panel.
1 - Yes (default) - The window will have the title bar.
Application dependent (dependent)Specifies whether the window will be dependend on the application main window. This configurator is visible only if the configuration is for: "Stand-alone or modal window".
0 - No - The window will be independent on the application main window.
1 - Yes (default) - The window will be dependent on the application main window and will always be on top of the application.
Always on top (ontop)Specifies whether the window will be "Always on top". This configurator is visible only if the configuration is for: "Stand-alone or modal window".
0 - No (default) - The window will not be "Always on top".
1 - Yes - The window will be "Always on top". So far it is not functional when opening Web panel.
Initial state (state)Specifies the initial state of the window. This configurator is visible only if the configuration is for: "Stand-alone or modal 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.
Forbid state change (fixed:state)Forbids to change the window state (normal / maximized / minimized). This configurator is visible only if the configuration is for: "Stand-alone or modal window".
No (default) - The window state can be changed.
Yes - The window state cannot be changed.
Initial position (pos)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. This configurator is visible only if the configuration is for: "Stand-alone or modal window".
top,center (default) - The window will be displayed in the center of the active application window (of the workspace).
top,x,y - The window will have the left upper corner in coordinates x and y (in pixels) relative to the active application window (of the 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 left upper 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.
Forbid position change (fixed:pos)Forbids to change the position of the window in normal state. This configurator is visible only if the configuration is for: "Stand-alone or modal window".
No (default) - The position of the window in normal state can be changed.
Yes - The position of the window in normal state cannot be changed.
Initial size (size)Specifies the initial size of the window in normal state. This configurator is visible only if the configuration is for: "Stand-alone or modal window".
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" tab.
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 borders and window title bar).
Forbid change of size (fixed:size)Forbids to change the size of the window in normal state. This configurator is visible only if the configuration is for: "Stand-alone or modal window".
No (default) - The size of the window in normal state can be changed.
size - The size of the window in normal state cannot be changed.
size2 - Disables changing the size of the window in normal state - the window size cannot be greater than the size of corresponding panel.
Show the scrollbars (scrollbar)Specifies whether the window will have the scrollbars and allows moving the contents, if the panel size is greater than the size of the window, the panel is inside.
0 - No - 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 - Yes (default) - The window displays the scrollbars and allows to scroll the panel, if the panel size is greater than the size of the window, the panel is inside.
Refresh period (refresh)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.
system (default) - The panel will have the automatic refresh according to the globally set system period (see PmaRoot > Application > Panels timer period).
0 - No - The panel will have its own refresh, i.e. the PmaPanel.Refresh method will be called.
Additional parametersAdditional parameters, that do not have specific configurators. The final string will consist of the values of specific configurators, that will be combined with the value in this configurator.
PROMOTIC 9.0.23 SCADA system documentation MICROSYS, spol. s r.o.

Send page remarkContact responsible person
Navigation:
 
 
- Setting of the sFramePars default values
 
 
© MICROSYS, spol. s r. o.