BI command description

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

Syntax: [ BI =  Block#  ;  HPos  ;  VPos  ;  Width  ;  Depth  ;  "FileName"  ;  HorOffset  ;  VerOffset  ;  HorScale  ;  VerScale  ;  BackColor  ;  BackTint  ;  Angle  ;  CornerRadius  ;  Type  ;  Anchored  ;  AnchorBlock  ;  Relative  ;  Reference  ;  Alignment  ;  CellAnchor (InDesign only)    ]

Block#
Integer 		• Block number (1-990 or 2000-32000 using the "PermRefs" option).
     
HPos
Picas/Points 		• Horizontal position of the block.
     
VPos
Picas/Points 		• Vertical position of the new block.
     
Width
Picas/Points 		• Width of the new block.
     
Depth
Picas/Points 		• Depth of the new block.
     
"FileName"
String 		  The name of the image to import. If the string is empty, then the image is not imported. The image type should be understandable by QuarkXPress.
     
HorOffset
Picas/Points 		  Horizontal offset of the image within the block.
     
VerOffset
Picas/Points 		  Vertical offset of the image within the block.
     
HorScale
Percent 		  Horizontal scaling percentage.
     
VerScale
Percent 		  Vertical scaling percentage.
     
BackColor
Integer 		  Color applied to the background of the block. 0->White, 1->Blue, 2->Cyan, 3->Yellow, 4->Magenta, 5->Black, 6->Registration, 7->Red, 8->Green. 9->None If the value is >= 10, PageMakeUp will use the internal color table. (see [dc] command).
     
BackTint
Percent 		  Value of the background tint.
     
Angle
  Rotation angle of the block 0-360°.
     
CornerRadius
Points/Tenths 		  Radius of rounded corners.
     
Type
Integer 		  Block type: 0->Square 1->Concave 2->Convex 3->Straight 4->Circular
     
Anchored
Boolean 		  Indicate whether the new block is an anchored block. TRUE = anchored block. FALSE = block placed in absolute position.
     
AnchorBlock
Integer 		  Number of the text block in which to anchor the new box. (-1) for the current block.
     
Relative
Boolean 		  This parameter indicate if the new block is to be created relatively to an existing block or in absolute position in a page. TRUE= The new block is relative to an existing block. The block number is given in the "Ref" parameter and can be: -1= current block 0= startup block FALSE= The new block is placed in absolute in the page whose number is given in the "Ref" parameter.
     
Reference
Integer 		  This parameter could have 2 meanings depending on the "Relative" flag. If "Relative = TRUE" then the "Ref" parameter is a block id on which to align the new block (-1= current block). If "Relative = FALSE", then the "Ref" parameter is a page number (0=current page).
     
Alignment
Integer 		  When creating a block in relative mode "Relative=TRUE", this parameter allows you to indicate on which point you whish to align the new block. 0= Top of existing block. 1= Bottom of existing block. 2= From the position of the text cursor.
     
CellAnchor (InDesign only)
Boolean 		  TRUE=the image frame will be inserted in the current table cell (the topleftmost if selection contains several cells).
     

Note: The new block becomes the current block. The default value of the Ref parameter may differ according to the Relative parameter.

Example: [bi= 25 ; 5,00; 2,00; 10 ; 15] Creates a box named '25'. The box is placed 5 cm from the left side and 2 cm from the top of the starting point. The width of the box is 10 cm and its depth is 15 cm.

See also: [fh] Create horizontal line, [fv] vertical line

The • sign indicates a mandatory parameter

 

 

©1993-2008 Trias.
All rights reserved.