HomePowerBuilderAppeon Documentation Center

ArrangeSheets

Description

Arranges the windows contained in an MDI frame. (Windows that are contained in an MDI frame are called sheets.) You can arrange the open sheets and the icons of minimized sheets or just the icons.

Applies to

MDI frame windows

Syntax

mdiframe.ArrangeSheets ( arrangetype )

Argument

Description

mdiframe

The name of an MDI frame window.

arrangetype

A value of the ArrangeTypes enumerated datatype specifying how you want the open sheets arranged in the MDI frame window. Values are:

  • Cascade! -- Cascade the sheets that are not minimized so that each sheet's title bar is visible and arrange icons of minimized sheets in a row at the bottom of the frame.

  • Layer! -- Layer the sheets that are not minimized so that each sheet completely covers the one below it and arrange icons of minimized sheets in a row at the bottom of the frame.

  • Tile! -- Tile the sheets that are not minimized so that they do not overlap and arrange icons of minimized sheets in a row at the bottom of the frame.

  • TileHorizontal! -- Tile the sheets that are not minimized so that each is beside the other without overlapping and arrange icons of minimized sheets in a row at the bottom of the frame.

  • Icons! -- Arrange the minimized sheets in a row at the bottom of the frame.


Return value

Integer.

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

Examples

This statement in the script for the Clicked event for an item on a menu tiles the open sheets that are not minimized in the MDI frame window called MDI_User: 

MDI_User.ArrangeSheets(Tile!)

This statement in the script for the Clicked event for an item on a menu arranges the icons of the minimized sheets at the bottom of the MDI frame window called MDI_User: 

MDI_User.ArrangeSheets(Icons!)

See also

GetActiveSheet

OpenSheet

Prev  Up  Next
Arrange  Home  Asc