PageStream - Documents:GetGuideDisplay

<< GetGuide	GetGuides >>
Top: Documentation Library	Up: G Commands

Gets the guide display status.

getguidedisplay [DEPTH layer] [PAGE flag] [PAGECOLOR stem] [RULER flag] [RULERCOLOR stem] [WINDOW name]

DEPTH/k Gets the guide depth.

PAGE/k Gets the page guide display status.

PAGECOLOR/i Gets the red, green and blue components of the page guide color.

RULER/k Gets the ruler guide display status.

RULERCOLOR/i Gets the red, green and blue components of the ruler guide color.

WINDOW/s The window name. Default=current.

Results:

Returns the guide display status (ON|OFF) to RESULT.

If page and/or ruler guides are displayed, ON will be

returned.

DEPTH/k The depth: INFRONT |I NBACK.

PAGE/k The page guide display status: ON | OFF.

RULER/k The page guide display status: ON | OFF.

PAGECOLOR stem

red/i The red component of the color.

green/i The green component of the color.

blue/i The blue component of the color.

RULERCOLOR stem

red/i The red component of the color.

green/i The green component of the color.

blue/i The blue component of the color.

Examples:

getguidedisplay page pflag ruler rflag
if result=ON then do
   say 'Page Guides:  '||pflag
   say 'Ruler Guides: '||rflag
end

User Contributed Comments For GetGuideDisplay	sign in to add a comment
Dan Kilroy wrote...	2006-05-04 17:17:15
Script command submitted from PageStream internal documentation. Needs to be checked and merged with the command documentation above. Gets the {...} . mode<ON\|OFF> = GetGuideDisplay ([PAGE &pflag] [RULER &rflag] [WINDOW document-window]) Parameters: Results: Notes: See Also: Examples: Python: ARexx: Applescript:
User Contributed Comments For GetGuideDisplay	sign in to add a comment