*EDIT (PRTPAGE)


10.7, PLBCMP GUI Only

*EDIT={top}:{bottom}:{left}:{right}:{cmdstr}

 

This PRTPAGE control is used to create a PDF 'variable field' bounded by {top}:{bottom}:{left}:{right} when the Sunbelt 'pdf:' output is being generated. By default, this control creates a PDF 'Text Field' as described under the 'Interactive Forms' ( Section 12.7.4.3 ) in the Adobe document 'PDF 32000-1:2008'. A PDF 'Text Field' can accept input keyed data from a user when the PDF is being rendered/shown using a PDF reader.

 

This advanced print control takes a comma separated list of commands as provided in the <cmdstr> data string. Each command is composed of a command identifier assigned using a '=' character followed by command data. The commands provide attributes and behaviors for the PDF variable field. The *EDIT commands actually generate PDF commands which take affect when the PDF file is being processed by a PDF reader

 

The following *EDIT commands are supported:

Where:

<cmdstr>
A user specified string that may or may not include double quote characters.

Commands:

B=<number>
Specifies the /BS border style used for the PDF variable field.
 
Value
Meaning
0
Border style is not used
1
/BS border style is used with a default border /W width of '1'
2
/BS border style is used where the /S style is set to /U to give an underline.
 
When the border style is being used ( 1 or 2 ) a border with a /W width of 1 is used. Also, the border color is set to be black and the background color is set to be white.
  
F=<number>
 
Specifies the /Ff bitmask flags! The 'nn' decimal value is the bitmasks value used by the /Ff command. See Spec 1.7 Table 220 and 221..
 
J=<string>

 

This command string is the JavaScript stream to filter/verify input data for a variable field. This JavaScript stream is only used when the 'T=99' type is set for user/custom filtering.
 
L=<number>
 
This command specifies the maximum character size to be allowed for the PDF variable field. See Spec 1.7 Table 229 for information for PDF 'MaxLen'.
 
N=<string>
 
This command string specifies a user defined field name the must be unique for each variable field name the must be unique for each variable field. If this 'N' command is not used for a variable field, an internal field name is used with the format of 'FN_nnnn' where the 'nnnn' is the PDF object number being used for a variable field. The file name size is restricted to 298 characters.
 
If the same field name is used for multiple PDF variable fields, only the last variable field with this duplicated field name will work as expected.
 
T=<number>
 
This command identifies the type of input filtering to be used for the PDF variable field. The input filtering is implemented using JavaScript logic applied using the PDF '/AA' command. See Spec 1.7 Table 28 a description.
 
Value
Meaning
0
Input field filtering is not used.
1
Numeric digits only ( 0 through 9 )
2
Numeric digits ( 0 through 9 ) + minus sign (-) + decimal point (.)
3
A-Z converted to lowercase as entered.
4
a-z converted to uppercase as entered
99
Customer user filtering is to be used. In this case, the *EDIT command string must include the 'J=' JavaScript logic stream to be used.

 

X=<string>

 

This command is used so a user program can provide an extra stream of valid PDF commands ( See Spec 1.7 ) which are to be applied to a PDF variable field.

 

Example:

 

Valid extra PDF commands may be applied as follows:

 

dExtra INIT "X=":

               " /Q 1": //Alignment Center

               " /TU (Numeric digits only!)": //Give 'tooltip

               " /DA (1 0 0 rg /Ti 12 Tf)": //Set FG color

                                             // and Font size

               " /V (1234)": //Default text

                                              // field value!

               // The next two lines of PDF commands can

               // only be used if the 'B=nn' *EDIT command

               // is NOT being used.

               //

               " /BS << /W .2 /S /U >>": //Border style width

                                        // and underline!"

               " /MK << /BC [0 1 0] /BG [0 0 1] >>"

                                       //Set Border color

                                       // to be Green and

                                       // Background color

                                       // to be Blue.

 

See Also: List Controls (PRTPAGE), PRTPAGE

 



PL/B Language Reference