AX2352

GetCalcMethod function

Inserts a calc method at the current location. If standard calc method controls are used in the sheet (InsertCMColumn), then the current row's InsertCM tag is used to control the insertion. If calc method controls are not used in the sheet, the standard Insert Calc Method dialog displays.

To insert the calc method, the user double-clicks on the cell containing the GetCalcMethod function.

NOTE: GetCalcMethod is not for use in Axiom forms. If you want to allow users to insert calc methods within Axiom forms, you must use the Add Rows command (either in a Button component or as a tag within a formatted grid). For more information, see Inserting calc methods in an Axiom form.

Syntax

GetCalcMethod("DisplayText")

Parameter Description
DisplayText

The display text for the cell containing the GetCalcMethod function. For example, the text could be something like "Insert a new account."

The DisplayText displays as normal text in the cell. If you want the text to appear like a hyperlink on a web page, you must manually apply the font formatting to the cell.

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell.

Remarks

  • GetCalcMethod is not supported for use with dynamic calc method controls (DynamicCMColumn). If a DynamicCMColumn is present in the sheet, then GetCalcMethod does not allow calc method insertion, even if the current row happens to have an InsertCM tag. However, if the sheet uses both dynamic controls and standard controls, then GetCalcMethod will work as expected with the enabled rows in the InsertCMColumn.

  • All calc method security permissions are honored as normal. The user must have rights to insert a calc method in order to use GetCalcMethod. If the user does not have the appropriate rights, then an error message displays when the function is double-clicked.

  • The Axiom Double-Click setting does not need to be enabled for the sheet in order to use GetCalcMethod.

  • GetCalcMethod is only valid for use in files that support calc method libraries. If used in other files, an error message displays when the function is double-clicked.

  • GetCalcMethod is a non-volatile function.

Examples

=GetCalcMethod("Insert a new account")

When a user double-clicks on the cell containing this function, Axiom checks for the presence of an InsertCMColumn in the sheet.

  • If an InsertCMColumn exists, Axiom checks for the presence of an InsertCM tag on the row:
    • If an InsertCM tag exists, that tag is used to control the calc method insertion. For example, if insertion is enabled and only one calc method is allowed, that calc method is inserted. If the tag does not allow insertion, then an error message is displayed.
    • If an InsertCM tag does not exist, then insertion is not allowed and an error message is displayed.
  • If no InsertCMColumn exists, the default Insert Calc Method dialog displays. The selected calc method is inserted.
See also