SCLFrame

Overview

The SclFrame command permits you to control various behaviours of the frame that represents the various components of Surpac. The behaviours that can be controlled include:

the 'iconified' state - the frame can be shrunk to an icon in the task bar or restored to normal size.
the position of the frame with respect to other frames - you can force it to display in the foreground.

This command is mostly useful when controlling Surpac over a remote control connection from a third party program. It might also be useful when you are running macros that might take a long time to execute because you can collapse the frame to an icon when a script commences and restore it and bring it to the front at the end of a script.

Synopsis

SclFrame sub-command frame-name.

Description

The SclFrame command allows you to 'iconify' a frame, 'deiconify' a frame or force a frame to the front of all other frames. The action to be performed is defined by the sub-command. The frame to which the action is to be applied is defined by the frame name. If an invalid sub-command or an invalid frame name is used, the SclFrame command is silent and performs no action.

Arguments

sub-command

Passed by value. This is the action to be applied to the specified frame. Permitted values are:

iconify - Collapse the specified frame to an icon on the task bar. If the frame is already collapsed to an icon, no change is made to the iconified state.
deiconify - Restore the specified frame from an icon on the task bar to its previous size. If the frame is already in a normal deiconified state no change is made.
bringtofront - Restore the specified frame from an icon on the task bar to its previous size and force it to be at the front of all other window frames. If the frame is already in a normal deiconified state but not at the front then it is brought to the front. Due to certain behaviours of Java and how it interacts with the Microsoft window manager, there may be times when bringtofront doesn't bring the frame to the front as it should.

frame-name

The name of the frame to which the specified action is to be applied. Surpac has a number of frames, each having a specific name. Valid names for the frames include:

graphics - This is the main 3D graphics frame that is first displayed when Surpac starts.
plotting - The is the frame that is used to display and edit plots produced by Surpac.
scheduling - This is the frame used for the graphical sequencer module.
sheetsetup - This is the sheet setup frame that is used to create and edit plotting sheet components (borders, drawing areas, title blocks and grids).
stability - This is the frame used by the Survey Stability monitoring module.
statistics - The is the frame used for the Basic Statistics module.
variogram - This is the frame used for the variogram and indicator variogram modelling.

Examples

SclFrame iconify graphics

SclFrame deiconify graphics

SclFrame bringtofront plotting