GetTextWrap Object Query Command

GETTEXTWRAP Object Queries

Gets the text wrap status of an object.

gettextwrap [REGION mode] [WRAP type] [STANDOFF stem] [DOCUMENT name | WINDOW name | OBJECTID number]

REGION/k Gets the wrap mode.

WRAP/k Gets the wrap type.

STANDOFF/a Gets the text offset from the object.

DOCUMENT/s The document name. Default=current.

WINDOW/s The window name. Default=current.

OBJECTID/i The object number. Default=current.

Results:

REGION/k The wrap mode: SHAPE | BOUNDINGBOX | FENCE.

WRAP/k The wrap type: NOWRAP | WRAPLEFT | WRAPRIGHT | WRAPJUMP | WRAPAROUND | WRAPINSIDE.

STANDOFF stem

x/d The horizontal offset.

y/d The vertical offset.

Examples:

gettextwrap region mode wrap type standoff offset
if mode~='NOWRAP' then
say 'Text will '||type||' by '||offset.x||ยจ
' horizontally, and '||offset.y||' vertically.'

 

GetTextWrap  Command Definition  url:PGScmd/gettextwrap
  created:2006-03-30 22:20:08   last updated:2006-03-31 13:13:16
  Copyright © 1985-2024 GrasshopperLLC. All Rights Reserved.

User Contributed Comments For GetTextWrap
Dan Kilroy wrote...2006-05-03 19:09:21

Script command submitted from PageStream internal documentation. Needs to be checked and merged with the command documentation above.

Gets the {...} .

GetTextWrap ([REGION &region<SHAPE|BOUNDINGBOX|FENCE>] [STANDOFF &offset/.X.Y] [WRAP wrap<NOWRAP|WRAPLEFT|WRAPRIGHT|WRAPJUMP|WRAPAROUND|WRAPINSIDE>] [DOCUMENT document | WINDOW document-window | OBJECTID objectid])


Parameters:


Results:


Notes:


See Also:


Examples:
Python:


ARexx:

Applescript:

User Contributed Comments For GetTextWrap