Pane Genie
- Last UpdatedJul 18, 2023
- 5 minute read
Genie Name: pane
Genie Library: sa_workspace
System Project: SA_Include
A Pane Genie can be used to add a pane to a master page. See Create a Master Page for a Customized Workspace.
It can also be used for popup windows that support autofill functionality. See Create a Pop-up Window with Panes.
Genie Properties
Complete the following properties for the genie in the Genie Properties dialog box.
-
AN: This is an automatically-generated unique ID for the genie object.
-
Name: Optional. If you need to reference the Genie at runtime using Cicode, specify a unique name.
Pane Properties
|
Property |
Description |
|---|---|
|
Name |
The name used to identify the pane. The name needs to be unique; two panes on the same page cannot have the same name. The syslog.dat file for the client will log a message if it detects duplicate panes. |
|
Default Page |
The name of the page that the pane will display at startup. If the FillMode for the pane is set to an Autofill option, this page will also display when a context change results in the pane having no content to display. |
|
Display Mode |
Determines how the content of a pane will change as the pane is resized. Use one of the following integers to specify a display mode:
|
|
Is Default Pane? |
Set this property to TRUE if you want the pane to be the default pane within the workspace. This will make the pane the primary point of reference for the workspace. The default pane is used to display pages that have no content type defined. Each workspace can only contain one default pane. The syslog.dat file for a client will indicate if a default pane is not specified. The workspace Header Bar will refer to the page displayed in the default pane to source the active page title and breadcrumbs. This will also determine the current selection in the Navigation Zone. |
|
Display Scrollbars |
Determines if the pane will include scrollbars at runtime.
Scrollbars will only appear if the pane's DisplayMode property is set to 3 (maintain size), and the page displayed is larger than the pane. |
|
Fill Mode |
Determines how the content of a pane is updated as context changes. Use one of the following integers to specify a fill mode:
|
|
ContentTypes |
Defines the type of content the pane will display. You can specify zero or more types as a comma separated list. Specifying no content type is acceptable for a static pane, but it is recommended that any other type of pane has at least one content type specified. The content types you can use are configured in Visualization activity. At runtime, only pages with a content type that matches with the pane will be displayed. See Content Types. |
|
Excluded Autofill Panes |
Allows you to specify panes that will not display updated content when an equipment context change is triggered from this pane. When the context changes in the current pane, the content in the excluded panes will remain static. However, the context in excluded panes will still be updated. Any pane in the workspace or a linked workspace can be excluded. Specify the name(s) of one or more panes or nested panes that you want to exclude from autofill. Use a comma to specify more than one pane name. For more information, see Excluding Panes (below). |
|
Tab Header Pane Name |
If you want the content of the pane to be controlled via a set of tabs, you can use this property to indicate the pane where the associated tab bar is located. Enter the name of the pane that hosts a page with the tab bar Genie on it. |
|
Tab Control Name |
Enter the name of the tab bar Genie that you would like to use to control the content of the pane. The tab control needs to be located on the page of the pane specified in the Tab Header Pane Name property (see above). |
|
Equipment Reference Associations: Categories |
This field allows you to associate a pane with an equipment reference category, or a comma-separated list of equipment reference categories (see "Category" in the topic Define Equipment References). When a piece of equipment comes into context, any equipment references within the specified category will be used to create Super Genie associations for a displayed page. For more information, see AssEquipReferences. |
Excluding Panes
As described above, you can use the Pane Properties dialog box to add a list of panes that you wish to exclude from autofill. Excluded panes will show the same content regardless of the context. If the current pane changes context, content in the panes specified in the Exclude Autofill Panes box will not be updated.
Note: The context within excluded panes will be updated when the context of the current page changes.
It is also possible to exclude panes at runtime by using a page environment variable. To do this:
-
Open the page that contains the context that will change.
-
Open the Page Properties dialog box.
-
Select the Environment tab.
-
Click Add. The Edit Properties dialog box is displayed.
-
In the Property box, type the property name ExcludedAutoFillPanes.
-
In the Value box, specify the name(s) of one or more panes that you want to exclude from autofill.
-
Click OK to close the Edit Properties dialog box.
-
Click OK to close the Page Properties dialog box.