BN command description


Description: This commande creates a new text block in a page of the document. The LinkTo parameter allows to link the new block with an existing block. The existing block may contain text. If the existing block is already linked, the new block is inserted in the link.


Syntax: [ BN =  Block#  ;  HPos  ;  VPos  ;  Width  ;  Depth  ;  Alignement  ;  TopOffset  ;  BackColor  ;  BackTint  ;  LinkTo  ;  LinkTo  ;  NumCol  ;  Gutter  ;  TextInset  ;  Angle  ;  Anchored  ;  AnchoredBox  ;  Relative  ;  Ref  ;  Alignment  ;  MaxVerJust  ;  TopAlignment    ]


Block#
Integer
The Block number of the new box. Valid range is from 1 to 999 with the standard version of PageMakeUp. PermRefs extends the range with values from 2000 to 32000.
     
HPos
Picas/Points
Horizontal position of the new block in the page.
     
VPos
Picas/Points
Vertical position of the new block in the page.
     
Width
Picas/Points
Width of the new block.
     
Depth
Picas/Points
Depth of the new block.
     
Alignement
Integer
  Vertical alignement of text. 0-> top 1-> justified 2-> centered 3-> bottom
     
TopOffset
Picas/Points
  Offset of first base line of text.
     
BackColor
Integer
  Background color 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 (0-100).
     
LinkTo
  This boolean flag indicates that the new block is to be linked to an existing block ("linkTo" parameter). TRUE=Link this block with the "LinkTo" block. FALSE=No link.
     
LinkTo
Integer
  Number of the block with which to create a link. The block should exist. Use -1 to link to the current block.
     
NumCol
Integer
  Number of columns.
     
Gutter
Points/Tenths
  Width of gutter.
     
TextInset
Points/Tenths
  Inset of text within the block.
     
Angle
  Rotation angle of the block.
     
Anchored
Boolean
  Indicate if the new block is to be anchored in an existing block. If TRUE the next parameter ("AnchoredBlock") indicates in which block to place the new block. TRUE=Anchored. FALSE= Normal.
     
AnchoredBox
Integer
  Number of block in which to place the new block. -1 indicate the current block.
     
Relative
Boolean
  This parameter indicates 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.
     
Ref
  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", then 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.
     
MaxVerJust
Points/Tenths
  Define the maximum space allowed before paragraphs for vertical justification by QuarkXPress in this block.
     
TopAlignment
Integer
  Indicate which type of alignement is to be used for the text in the box. Quark Version : 0->Ascent 1->Cap + Accent 2->Cap height InDesign Version : 0->Ascent 1->Cap Height 2->Leading 3->x Height 4->Fixed
     


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


Example: [bn= 25 ; 5,00; 2,00; 10 ; 15] Create a block named '25' on page 3. The block is placed at 5 cm of the left side and 2 cm from the top of the starting point. The width of the block is 10 cm and its depth is 15 cm.


See also: [fh] Create Horizontal Rule, [fv] Create Vertical Rule.


The • sign indicates a mandatory parameter

 

 

©1993-2008 Trias.
All rights reserved.