OpenSheetDocked

Description

Opens a sheet docked in a specified position within an MDI frame window for dockable windows.

Applies to

Window objects

Syntax

OpenSheetDocked ( sheetrefvar {, windowtype }, mdiframe, position, sheetname )

Argument

Description

sheetrefvar

The name of any window variable that is not an MDI frame window. OpenSheetDocked places a reference to the open sheet in sheetrefvar.

windowtype (optional)

A string whose value is the datatype of the window you want to open. The datatype of windowtype must be the same or a descendant of sheetrefvar.

mdiframe

The name of an MDI frame window.

position

An enumerated type that specifies where to dock the sheet:

  • WindowDockLeft!

  • WindowDockRight!

  • WindowDockTop!

  • WindowDockBottom!

sheetname

A unique string identifier for the sheet, which is used when layout is persisted.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, OpenSheetDocked returns null. In some cases, such as if the windowtype argument is invalid, OpenSheetDocked 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

Open the sheet, docked in a specified position.