Opens a sheet as a document within an MDI frame window for dockable windows.

Applies to

Windows objects

Syntax

OpenSheetAsDocument ( <sheetrefvar> {, <windowtype> }, <mdiframe>, <sheetname> {, <tabalign> } )

Returns

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

Tabbed documents can be in more than one tab group. Users can create additional tab groups by dragging one tab outside of the current group. If there is more than one tab group, use the <mdiframe> argument to specify in which one to open a sheet. Instead of specifying the parent window, specify an already open sheet in the tab group where you want to open your new sheet.

Opens a sheet as a document within an MDI frame window for dockable windows. OpenSheetWithParmAsDocument also stores a parameter in the system's Message object so that it is accessible to the opened sheet.

Applies to

Windows objects

Syntax

OpenSheetWithParmAsDocument ( <sheetrefvar>, <parameter> {, <windowtype> }, <mdiframe>, <sheetname> {, <tabalign> } )

Returns

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

Tabbed documents can be in more than one tab group. Users can create additional tab groups by dragging one tab outside of the current group. If there is more than one tab group, use the <mdiframe> argument to specify in which one to open a sheet. Instead of specifying the parent window, specify an already open sheet in the tab group where you want to open your new sheet.

The system Message object has three properties for storing data. Depending on the datatype of the parameter specified for OpenSheetWithParmAsDocument, scripts for the opened sheet would check one of the following properties.

In the opened window, it is a good idea to access the value passed in the Message object immediately (because some other script may use the Message object for another purpose).

NoteWhen you pass a PowerObject as a parameter, you are passing a reference to the object. The object must exist when you refer to it later or you get a null object reference, which causes an error. For example, if you pass the name of a control on a window that is being closed, that control will not exist when a script accesses the parameter.

Opens a sheet docked in a specified position within an MDI frame window for dockable windows. OpenSheetWithParmDocked also stores a parameter in the system's Message object so that it is accessible to the opened sheet.

Applies to

Windows objects

Syntax

OpenSheetWithParmDocked ( <sheetrefvar>, <parameter> {, <windowtype> }, <mdiframe>, <position>, <sheetname> )

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, OpenSheetWithParmDocked returns null. In some cases, such as if the <windowtype> argument is invalid, OpenSheetWithParmDocked 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 system Message object has three properties for storing data. Depending on the datatype of the parameter specified for OpenSheetWithParmFromDocked, scripts for the opened sheet would check one of the following properties.

In the opened window, it is a good idea to access the value passed in the Message object immediately (because some other script may use the Message object for another purpose).

Note

When you pass a PowerObject as a parameter, you are passing a reference to the object. The object must exist when you refer to it later or you get a null object reference, which causes an error. For example, if you pass the name of a control on a window that is being closed, that control will not exist when a script accesses the parameter.

Opens a sheet in a tab group within an MDI frame window for dockable windows.

Applies to

Windows objects

Syntax

OpenSheetInTabGroup ( <sheetrefvar> {, <windowtype> }, <siblingname>, <sheetname> )

Returns

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.

Opens a sheet in a tab group within an MDI frame window for dockable windows. OpenSheetWithParmInTabGroup also stores a parameter in the system's Message object so that it is accessible to the opened sheet.

Applies to

Windows objects

Syntax

OpenSheetWithParmInTabGroup ( <sheetrefvar>, <parameter> {, <windowtype> }, <siblingname>, <sheetname> )

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, OpenSheetWithParmInTabGroup returns null. In some cases, such as if the <windowtype> argument is invalid, OpenSheetWithParmInTabGroup 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. The system Message object has three properties for storing data. Depending on the datatype of the parameter specified for OpenSheetWithParmFromDockingState, scripts for the opened sheet would check one of the following properties.

In the opened window, it is a good idea to access the value passed in the Message object immediately (because some other script may use the Message object for another purpose).

Note

When you pass a PowerObject as a parameter, you are passing a reference to the object. The object must exist when you refer to it later or you get a null object reference, which causes an error. For example, if you pass the name of a control on a window that is being closed, that control will not exist when a script accesses the parameter.

Sample code for opening docked windows and tabbed documents.

Procedure

Windows objects

1. Create a window w_sheet_any as a main! window type.
2. In the open event of w_sheet_any, add this code:

   string ls_i  
   ls_i = Message.stringparm  
   if not isnull(ls_i) and ls_i <> "" then
         this.title = ls_i  
   end if

3. Create an MDIDock window w_mdidock_dockstate and set any menu in it.
4. In the open event of w_mdidock_dockstate, add this code:

   window win[]  
   OpenSheetWithParmDocked(win[1], "1", "w_sheet_any", this, WindowDockLeft!, "")  
   OpenSheetWithParmInTabGroup(win[2], "2", "w_sheet_any", this, "")  
   OpensheetWithParmInTabGroup(win[3], "3", "w_sheet_any", win[1], "")  
   OpenSheetWithParmAsDocument(win[4], "4", "w_sheet_any", this, "")  
   OpenSheetWithParmAsDocument(win[5], "5", "w_sheet_any", win[4], "")  
   OpenSheetWithParmAsDocument(win[6], "6", "w_sheet_any", this, "", false)  
   OpenSheetWithParmAsDocument(win[7], "7", "w_sheet_any", win[5],  "")  
   OpenSheetWithParmAsDocument(win[8], "8", "w_sheet_any", win[6],  "")

5. Run the application
   You will see windows 1 and 3 as a tabbed group, with the tabs at the bottom. Sheets 4, 5, and 7 appear as tabbed documents together, as do 6 and 8, both groups with tabs at the top. Window 2 is alone and untabbed.

Sets the unique identifier for an open sheet.

Applies to

Window objects

Syntax

<controlname>.SetSheetID ( <sheetname> )

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, SetSheetID returns null.

Usage

If no sheet indentifier was set when it was opened by one of the OpenSheet functions, you can set an ID using theSetSheetID function. You can also change a sheet's ID.

Example

window win[]  OpenSheetDocked(win[1], this, WindowDockLeft!, "")  win[1].SetSheetID("sheet1")

Stores the MDI state in the registry.

Applies to

Window objects

Syntax

SaveDockingState ( <regkey> )

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, SaveDockingStatereturns null.

Usage

You can set the application so that it saves the states of the open sheets. You should call this function when the application closes.

Example

integer li_rtn  string is_register = "Sybase\PowerBuilder\Examples\Docking\"  li_rtn = this.SaveDockingState (is_register)

Loads two arrays of equal size: type names of persisted sheets and the corresponding IDs.

Applies to

Window objects

Syntax

LoadDockingState ( <regkey>, <windowtypes>, <sheetnames> )

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, LoadDockingStatereturns null.

Usage

To retrieve the MDI states that were saved using the SaveDockingState function, use LoadDockingState to get the window information from the registry. Next, use OpenSheetFromDockingState orOpenSheetWithParmFromDockingState to open each of the persisted sheets. Finally, use CommitDocking to do the final arrangement and make the sheets visible.

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

Applies to

Windows objects

Syntax

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

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, OpenSheetFromDockingState returns null.

Usage

Open persisted sheets in their saved docking states.

Opens one or more persisted sheets within an MDI frame window for dockable windows.OpenSheetWithParmFromDockingState also stores a parameter in the system's Message object so that it is accessible to the opened sheet.

Applies to

Windows objects

Syntax

OpenSheetWithParmFromDockingState ( <sheetrefvar>, <parameter> {, <windowtype> }, <mdiframe>, <sheetname> )

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null,OpenSheetWithParmFromDockingState returns null.

Usage

The system Message object has three properties for storing data. Depending on the datatype of the parameter specified for OpenSheetWithParmFromDockingState, scripts for the opened sheet would check one of the following properties.

In the opened window, it is a good idea to access the value passed in the Message object immediately (because some other script may use the Message object for another purpose).

Note

When you pass a PowerObject as a parameter, you are passing a reference to the object. The object must exist when you refer to it later or you get a null object reference, which causes an error. For example, if you pass the name of a control on a window that is being closed, that control will not exist when a script accesses the parameter.

After all persisted sheets are opened, this function arranges them and makes them visible.

Applies To

Window objects

Syntax

CommitDocking()

Usage

When all persisted sheets are opened using the LoadDockingState and OpenSheetFromDockingState orOpenSheetWithParmFromDockingState, the CommitDocking function does the work of arranging everything in place and making it all visible.

Example

Restore all sheets for register

string s1[], s2[]  
string is_register = "Sybase\PowerBuilder\Examples\Docking\"  
integer li_start, li_end, li_i, li_rtn  
li_rtn = LoadDockingState(is_register,s1,s2)  
window lw_window  li_start = lowerbound(s1)  
li_end = upperbound(s2)
    
for li_i = li_start to li_end
  	openSheetFromDockingState(lw_window,s1[li_i], this, s2[li_i])  
next  
CommitDocking()