MDIClient object

An MDI window is a frame window in which you can open multiple document windows (sheets) and move among the sheets.

An MDIClient object is the area in which open sheets display in a standard MDI frame. In a standard MDI window, PowerBuilder sizes the MDIClient so that it fills the space inside the frame. For example, if the frame has a menu bar and MicroHelp, the MDIClient fills the space between the sides of the frame and the space below the menu bar and above the MicroHelp.

In a custom MDI window, you determine the size of the client area. For example, when a frame has buttons below the menu bar in the frame, you size the client area so it begins below the buttons.

An MDIClient object has no associated events.

Properties

MDIClient property

Datatype

Description

BackColor

Long

Specifies the numerical value of the background color: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

BringToTop

Boolean

Specifies whether PowerBuilder moves the MDIClient object to the top of the front-to-back order. Values are:

TRUE -- Object moved to top.

FALSE -- Object not moved to top.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

Height

Integer

Specifies the height of the MDIClient object, in PowerBuilder units.

MicroHelpHeight

Integer

Holds the height of the MicroHelp in the MDIClient object.

If the style of the MDI window is MDI Frame (no MicroHelp), MicroHelpHeight is 0; otherwise, it is the height of the MicroHelp.

You cannot set the value of this property.

Tag

String

Specifies the tag value assigned to the MDIClient object.

Visible

Boolean

Specifies whether the MDIClient object is visible. Values are:

TRUE -- Object is visible.

FALSE -- Object is not visible.

Width

Integer

Specifies the width of the MDIClient object, in PowerBuilder units.

X

Integer

Specifies the X position (the distance from the left edge of the MDI frame window), in PowerBuilder units.

Y

Integer

Specifies the Y position (the distance from the top of the MDI frame window), in PowerBuilder units.


Functions

MDIClient function

Datatype returned

Description

ClassName in PowerScript Reference

String

Returns the name assigned to the MDIClient object.

GetContextService in PowerScript Reference

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent in PowerScript Reference

PowerObject

Returns a reference to the name of the parent object.

Hide in PowerScript Reference

Integer

Makes the MDIClient object invisible.

Move in PowerScript Reference

Integer

Moves the MDIClient object to a specified location.

Resize in PowerScript Reference

Integer

Changes the size of the MDIClient object.

SetRedraw in PowerScript Reference

Integer

Controls automatic redrawing of the MDIClient object after each change in its properties. To reduce flicker when the user closes all the sheets, set SetRedraw to FALSE.

Show in PowerScript Reference

Integer

Makes the MDIClient object visible.

TypeOf in PowerScript Reference

Object

Returns the type of the object.