Arbortext Command Language > Functions by Alphabetical Listing > doc_format_needed
  
doc_format_needed
doc_format_needed ([doc[, needed]])
This function returns and optionally sets the format needed state of an open document as displayed in the status bar. If the needed parameter is specified, the state is set according to the following values:
0 — Clears the format-needed status.
1 — Sets the format-needed status.
2 — Sets the reformat-needed status (when another formatting pass is required).
doc_format_needed returns the previous state. If the doc parameter is omitted or 0, the current document is used.
Related Topics
doc_formattable function