B* command description


Description: This command creates an image frame (a polygon or a composition of polygons) in a page of a document. The box may be placed in absolute, relative or anchored in an existing box.


Syntax: [ B* =  Block#  ;  HPos  ;  VPos  ;  Width  ;  Height  ;  NbPaths  ;  NbPointsN  ;  IsClosedN  ;  XPosNLeftAnchorK  ;  VPosNLeftAnchorK  ;  HPosNMiddleAnchorK  ;  VPosNMiddleAnchorK  ;  HPosNRightAnchorK  ;  VPosNRightAnchorK  ;  Alignment  ;  TopOffset  ;  BackColor  ;  BackTint  ;  LinkTo  ;  LinkToBlock  ;  NbCol  ;  Gutter  ;  Inset  ;  Angle  ;  Anchored  ;  AnchorBlock  ;  Relative  ;  Ref  ;  Alignment  ;  MaxVertJust  ;  TopAlignment    ]


Block#
Integer
  Reference of the new text frame
     
HPos
Picas/Points
Horizontal position of the frame
     
VPos
Picas/Points
Vertical position of the frame
     
Width
Picas/Points
  Not used
     
Height
Picas/Points
  Not used
     
NbPaths
Integer
  Number of polygons in the frame
     
NbPointsN
Integer
  Number of points in the Nth polygon of the frame
     
IsClosedN
Boolean
  TRUE if the path of the Nth polygon is closed, FALSE if it's open
     
XPosNLeftAnchorK
Points/tenths
Horizontal position of the Kth left anchor point of the Nth polygon
     
VPosNLeftAnchorK
Points/tenths
Vertical position of the Kth left anchor point of the Nth polygon
     
HPosNMiddleAnchorK
Points/tenths
Horizontal position of the Kth middle anchor point of the Nth polygon
     
VPosNMiddleAnchorK
Points/tenths
Vertical position of the Kth middle anchor point of the Nth polygon
     
HPosNRightAnchorK
Points/tenths
Horizontal position of the Kth right anchor point of the Nth polygon
     
VPosNRightAnchorK
Points/tenths
Vertical position of the Kth right anchor point of the Nth polygon
     
Alignment
Integer
 
     
TopOffset
Picas/Points
 
     
BackColor
Integer
 
     
BackTint
Percent
 
     
LinkTo
Boolean
 
     
LinkToBlock
Integer
 
     
NbCol
Integer
 
     
Gutter
Points/tenths
 
     
Inset
Points/tenths
 
     
Angle
Integer
 
     
Anchored
Boolean
 
     
AnchorBlock
Integer
 
     
Relative
Boolean
 
     
Ref
Integer
 
     
Alignment
Integer
 
     
MaxVertJust
Points/tenths
 
     
TopAlignment
Integer
 
     


Note: See [BN] command for parameter description, since they are identical from Alignement.


Example:


See also:


The • sign indicates a mandatory parameter

 

 

©1993-2008 Trias.
All rights reserved.