Description
Get/set the caption value. Default is empty.
Use * for the standard caption
Custom caption rules
Use | for new line
In version 1.6 or newer
•&n = number
•&0n = number 0-padded
•&#n = number space-padded
•&t = title name (since version 1.6)
•&i = id
•&s = section
•&z = zone
•&e = edition name
•&c = page color
•&C = page color (spot name)
•&st = page status (since version 1.6) (Normal, InUse, ReadOnly)
•&sx = section extra string (since version 1.6)
•&zx = zone extra string (since version 1.6)
•&ed = edition date (since version 1.6)
•&en = edition number name (since version 1.6)
•&u = user name (since version 1.6)
•&U = user full name (since version 1.6)
•&dmp = last modified date page (since version 1.6)
•&D = current time (since version 1.6)
•&w = workstate name (since version 1.6)
•&x = not used
In version 1.5
&e edition date and name as specified in descName
&s section name
&z zone name
&n page number
&np padded page number
&i page id
&c page color kind
&C page spot color name
You can apply substringing to above variables, by:
&e[1,3]
means take only first three characters and the edition identifier.
Syntax
optprint.Caption [=] sCaption |
optprint
print options object created by Fred.GetPDFOptions("") or Ted.GetPDFOptions("")
sCaption
caption content
Example
Dim optPrint As Editorial.PrintOptions = Nothing
optPrint = Fred.GetPDFOptions("")
optPrint.Caption= "&e &z &0n"