OpenSheetInTabGroup
PowerScript function
Description
Opens a sheet in a tab group within an MDI frame window for dockable
windows.
Applies to
Window objects
Syntax
|
1 |
OpenSheetInTabGroup ( sheetrefvar {, windowtype }, siblingname, sheetname ) |
|
Argument |
Description |
|---|---|
|
sheetrefvar |
The name of any window variable that is not an MDI frame |
|
windowtype (optional) |
A string whose value is the datatype of the window you |
|
siblingname |
The name of a sibling window in either a docked state or |
|
sheetname |
A unique string identifier for the sheet, which is used |
Return value
Integer.
Returns 1 if it succeeds and -1 if an error occurs. If any
argument’s value is null, OpenSheetInTabGroup returns null. In some cases,
such as if the windowtype argument is invalid, OpenSheetInTabGroup throws
a runtime error and does not return a value; therefore, it is recommended
that you both test the return value and wrap the function call in a
try-catch block.
Usage
The first sheet opened in a main window cannot be opened using
OpenSheetInTabGroup or OpenSheetWithParmInTabGroup. To create a tab group,
open the first sheet as a docked sheet and then use that sheet as the
siblingname argument.