Workspace_SetSelContext

Sets the selected context of the workspace on the current page to the specified equipment name. This function is only necessary to use when you have excluded a pane configured as PANE_FILLMODE_Autofill, PANE_FILLMODE_AutofillContextMustMatch or PANE_FILLMODE_StaticContextMustMatch from the autofill system.

Typically, this function would be used when building your own custom selection adorner and paired with the Workspace_SelectEquipment() function.

Syntax

Workspace_SetSelContext(STRING sEquipmentName, STRING sEquipmentSecondaryContext)

sEquipmentName

Name of a piece of equipment.

sEquipmentSecondaryContext

The value of the equipment name that is set as the secondary context for related equipment. For example, for a Polar Star Composite Genie, this will be the value specified in the Equipment Name option in the Presentation Options dialog box. This is used to determine the number of symbols to be displayed for MEOs.

Return Value

N/A

Example

Workspace_SetSelContext(Cluster1.MyPlant.Mixing.TNK01");

Workspace_SelectEquipment();

Related Functions

Workspace_GetContext, Workspace_GetEquipmentCluster, Workspace_GetPageNameWithRes, Workspace_GetResolution, Workspace_GetSelContext, Workspace_GetWindow, Workspace_GetWorkspaceFromName, Workspace_GetWorkspaceFromWindow, Workspace_Init, Workspace_IsSelContext, Workspace_IsSystem_Initialised, Workspace_SelectEquipment, Workspace_ShowContent

See Also

Public Functions