OpenSheetFromDockingState

Description

Opens one or more persisted sheets within an MDI frame window for dockable windows.

Applies to

Window objects

Syntax

OpenSheetFromDockingState ( sheetrefvar {, windowtype }, mdiframe, sheetname )

Argument

Description

sheetrefvar

The name of any window variable that is not an MDI frame window. OpenSheetFromDockingState 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.

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, OpenSheetFromDockingState returns null.

UsageOpen persisted sheets in their saved docking states.