Commande: DF

DF command description

Description: This command checks the integrity of the welcome document compared with the command file before any operation. An error message is displayed if the document is non existing or if the number of blocks needed is too small. When interpreting the command file, the program does the following : [TB]. If a text block is selected, the program checks if this blocks is linked to a chain. In this case, the program looks for the first block of the chain and saves the blocks of the chain in a table. The first block in the chain is block #0, the second block is block #1 etc.

Syntax: [ DF = RequiredDoc ; NumBlock ; Unlink ; RelativeBlock ]

RequiredDoc Boolean	•	TRUE = The command file requires an opened document. FALSE = The TCL file creates the document.

NumBlock Integer	•	Number of blocks required when RequiredDoc = TRUE. Enter 0 when the TCL command file requires no blocks.

Unlink Boolean	•	TRUE = If the welcome block is linked, the links will be removed when the file is saved. FALSE = The links are preserved.

RelativeBlock Boolean	•	TRUE = coordinates relative to block 0. FALSE = The program checks if there is an existing document having at least one block and checks if the block is selected.

Note: The command file must know that the program will save the references of the welcome block, so the blocks must not be overwritten by the command file. The command file must take care when it creates new blocks.

Example:

See also:

The • sign indicates a mandatory parameter