tsc_RuncodeProperties

This class provides information about any runCode through its tsc_UITask.  

After a tsc_RuncodeProperties is constructed, it can be queried to determine what is required to launch the runCode's UITask, and whether it is currently able to be launched.

These methods are useful when implementing buttons or menus which cause a UITask to be launched, to disable or hide the item while conditions are not right for the task to run.  For instance, buttons to control total station modes are not useful when there is no instrument connected.

If the supplied x_Code has not been registered to a UITask, then the IsRegistered() method will return false, as will most other properties.

Both the built-in Trimble Access runcodes as well as any registered by the plugin may be queried.

Constructor

tsc_RuncodeProperties (x_Code runCode);
Makes an instance that references the UITask that is registered to the supplied run code.  The run code may be for any Survey Core UITask, or any UITask that the plugin has registered.  Invalid codes will return an item whose IsRegistered property is false.

Properties

bool IsRegistered();
Returns true iff the run code refers to a registered UITask.

x_Code RunCode();
Returns the runcode of the UITask, same as that supplied in the constructor.

bool RequiresJob();
Returns true if the UITask requires a job to be open.

bool RequiresStyle();
Returns true if a style is required (either chosen previously, or running).

bool SupportsGnss();
Returns true if this task is able to function with a GNSS receiver as its positioning device.

bool SupportsTS();  
Return true if this task is able to function with a total station as its positioning device.

bool EnableOnMenu();
Returns true if the Control used to run the task should be enabled.  If this is false, the user should be prevented from launching the task.

bool ShowOnMenu();
Returns true if the control used to run the task should be displayed.  If this is false, the user should be prevented from launching the task.

bool TickOnMenu();
Returns true if the task is in a selected on state. What this means is determined by the task itself, and is not implemented in plugin UITasks.

bool SeparateMenu();
Returns true if the item should be displayed with a menu separator between it and the item above.  This is not implemented in plugin UITasks.

bool TaskRequestsStationSetupStatus ();
Returns true if this task performs a station setup workflow.