OpenSheetWithParmDocked
PowerScript function
Description
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
Window objects
Syntax
|
1 |
OpenSheetWithParmDocked ( sheetrefvar, parameter {, windowtype }, mdiframe, position, sheetname ) |
|
Argument |
Description |
|---|---|
|
sheetrefvar |
The name of any window variable that is not an MDI frame |
|
parameter |
The parameter you want to store in the Message object when
|
|
windowtype (optional) |
A string whose value is the datatype of the window you |
|
mdiframe |
The name of an MDI frame window. |
|
position |
An enumerated type that specifies where to dock the
|
|
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, 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
OpenSheetWithParmDocked, scripts for the opened sheet would check one of
the following properties.
|
Message object property |
Argument datatype |
|---|---|
|
Message.DoubleParm |
Double |
|
Message.PowerObjectParm |
PowerObject (PowerBuilder objects, including user-defined |
|
Message.StringParm |
String |
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).
Avoiding null object references
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.