Formula (ViewColumn - Java)

Read-write. The formula for a column that is based on a simple function or a formula.

Note: This property is read-write with Release 6.5.

Defined in

ViewColumn

Data type

String

Syntax

public String getFormula()
    throws NotesException
public void setFormula(String formula)
    throws NotesException

Usage

For reading:

  • If the column is based on a formula, this property returns the formula.
  • If the column is based on a simple function, this property returns the formula equivalent. For example, if the column is the simple function "Creation Date," this property returns "@Created."
  • If the column is based on a field, this property returns an empty string.

For writing:

  • This property replaces the existing formula. The replacement formula must be valid and cannot be an empty string.
  • If the replacement formula is equivalent to a simple function, the column basis changes to the simple function.
  • If the formula is simply the name of a field, the column basis changes to the value of that field, IsField becomes true, and IsFormula becomes false.
  • If a formula (that is not simply the name of a field) is written to a column based on a field, the column basis changes to a simple function or a formula, IsFormula becomes true, and IsField becomes false.

Example