@IsDocBeingSaved (Formula Language)

Checks the current status of the document and returns 1 (True) if the document is being saved; otherwise, returns 0 (False).

Syntax

@IsDocBeingSaved

Return value

flag

Boolean

  • Returns 1 (True) only when the fields on the document are actually being saved
  • Returns 0 (False) when the fields on the document are not currently being saved

Usage

Use @IsDocBeingSaved in field formulas. It has limited usefulness in toolbar button, hotspot, and form action formulas. This function does not work in column, selection, agent, window title, form, or view action formulas.

If you are using this function to increment a counter, the count increases by one every time the user saves the form.

Examples

  1. This example returns 1 while the document is being saved.
    @IsDocBeingSaved
  2. This example returns 0 before or after the document is saved.
    @IsDocBeingSaved
  3. This formula sets the field named Readers, which is a Reader Names field, to Admins when the document is saved. Otherwise, it sets the Readers field to the value already in the field. This type of formula is useful for changing the Read Access of a document after it has been composed and saved.
    @If(@IsDocBeingSaved;"Admins";Readers)