@DocNumber (Formula Language)
In a column or window title formula, returns a string representing the entry number of the current document or category. For example, 2.3 indicates that the document is the third entry following the second entry.
Syntax
@DocNumber @DocNumber( separator ) @DocNumber( "" )
Parameters
separator
Text. Optional. Indicates a separator to be used in the document number instead of "." (period); must be one character.
""
Empty string argument. Optional. Tells the function to return the least significant item of the document number (in other words, its rightmost component).
Return value
docNum
Special text. The value that represents the document number of the document or category in the view. You cannot convert special text to a number.
Usage
Use @DocNumber in column or window title formulas. In window title or field formulas, it will evaluate to "0" until the document has been saved and reopened. This function does not work in any other formula.
This @function is calculated when the document is opened. Results are undefined in cases where the document is not opened, such as printing from a view.
You cannot use this function in Web applications, except in column formulas.
Examples
- This example returns 37.1.3 for entry 37.1.3.
@DocNumber - This example returns 37-1-3 for entry 37.1.3.
@DocNumber("-") - This example returns 3 for entry 37.1.3.
@DocNumber("")