Classes Class XbpPresSpace() :setAttrString()

Method XbpPresSpace():setAttrString() Foundation

Sets or returns the attributes for characters drawn by GraStringAt().

Syntax 
:setAttrString( [<aAttributes>] ) --> aOldAttributes
Parameters
<aAttributes> := Array( GRA_AS_COUNT )
<aAttributes> is an array whose elements contain the attributes for character strings drawn by the function GraStringAt().
#define constants for the character string attribute array
Array element #define | Value Default value
GRA_AS_COLOR GRA_CLR_* GRA_CLR_NEUTRAL
GRA_AS_BACKCOLOR GRA_CLR_* GRA_CLR_BACKGROUND
GRA_AS_MIXMODE GRA_FGMIX_* GRA_FGMIX_OVERPAINT
GRA_AS_BGMIXMODE GRA_BGMIX_* GRA_BGMIX_LEAVEALONE
GRA_AS_BOX { nXsize, nYsize } Depends on output device
GRA_AS_ANGLE { nX, nY } { 1, 0 }
GRA_AS_SHEAR { nX, nY } { 0, 1 }
GRA_AS_DIRECTION GRA_CHDIRN_* GRA_CHDIRN_LEFTRIGHT
GRA_AS_HORIZALIGN GRA_HALIGN_* GRA_HALIGN_LEFT
GRA_AS_VERTALIGN GRA_VALIGN_* GRA_VALIGN_BASE
GRA_AS_EXTRA nExtra 0
GRA_AS_BREAK_EXTRA nBreakExtra 0
Return

The :setAttrString() method returns an array containing a copy of the current character attributes. If new attributes are set using <aAttributes>, this method returns an array containing the previously set attributes.

Description

The :setAttrString() method determines the attributes for character strings drawn in the presentation space. Character strings (text) are drawn using the function GraString().

The function GraSetAttrString() is the functional equivalent of the :setAttrString() method. More information about character string attributes can be found in the discussion of the GraSetAttrString() function.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.