PageStream - Documents:GetSelectedObjects

<< GetScriptPath	GetSelectOnPaste >>
Top: Documentation Library	Up: G Commands

GetSelectedObjects Object Query Command

GETSELECTEDOBJECTS Object Queries

Gets the ID's of all selected objects, as well as their bounding box.

getselectedobjects [IDLIST stem] [BOUNDINGBOX bbox/.LEFT.TOP.RIGHT.BOTTOM] [DIMENSIONS dim/.LEFT.TOP.RIGHT.BOTTOM] [DOCUMENT name | WINDOW name | OBJECTID number]

IDLIST/a Gets the ID's of each selected object.

BOUNDINGBOX/a Gets the bounding box of the selected objects.

DIMENSIONS/a Gets the dimensions of the selected objects. New in ?? (prior to 5.0)

DOCUMENT/s The document name. Default=current.

WINDOW/s The window name. Default=current.

OBJECTID/i The object number. Default=current.

Results:

The object count is returned to RESULT.

IDLIST stem

0/i The ID of the first selected object.

1/i The ID of the second selected object.

etc.

BOUNDINGBOX stem

left/d The left coordinate.

top/d The top coordinate.

right/d The right coordinate.

bottom/d The bottom coordinate.

Results:

Returns the number of selected objects. Removed .COUNT from list in 5.0.2.11 so that they can be returned as a list instead of a dict in python. The return result still contains the count. However, any older Arexx script that relies on this stem variable will need to be updated.

Notes:

The bounding box includes the stroke thickness of objects, and is expanded to contain rotated objects.

Examples:

getselectedobjects boundingbox coord
say 'Left: '||coord.left
say 'Top: '||coord.top
say 'Right: '||coord.right
say 'Bottom: '||coord.bottom

User Contributed Comments For GetSelectedObjects	sign in to add a comment
Dan Kilroy wrote...	2006-05-03 19:26:47
Script command submitted from PageStream internal documentation. Needs to be checked and merged with the command documentation above. Gets the {...} . objectcount = GetSelectedObjects ([IDLIST &objectidlist/.0.1.2] [BOUNDINGBOX &bbox/.LEFT.TOP.RIGHT.BOTTOM] [DIMENSIONS &dim/.LEFT.TOP.RIGHT.BOTTOM] [DOCUMENT document \| WINDOW document-window \| OBJECTID objectid]) Parameters: Results: Notes: prior to 5.0.2.12 (5.0.3 Linux), IDLIST also included .COUNT See Also: Examples: Python: ARexx: Applescript:
User Contributed Comments For GetSelectedObjects	sign in to add a comment

<< GetScriptPath	GetSelectOnPaste >>
Top: Documentation Library	Up: G Commands

Username:
Password: