FieldFormula[U] property

Microsoft Visio Developer Reference

FieldFormula[U] property

   Example   

Returns the formula of the custom field represented by an object.

Version added

3.0

Syntax

strRet = object.FieldFormula

strRet

String. The formula of the custom field.

object

Required. An expression that returns a Characters object.

Remarks

If the Characters object does not contain a field or contains non-field characters, or if the field is not a custom field, the FieldFormula property returns an exception. Check the IsField and FieldCategory properties of the Characters object before getting its FieldFormula property.

The formula returned by the FieldFormula property corresponds to the formula that appears in the Custom formula box in the Field dialog box (click Field on the Insert menu).

Note Beginning with Visio 2000, you can refer to Visio shapes, masters, styles, pages, rows, and layers using local and universal names. When a user names a shape, for example, the user is specifying a local name. Universal names are not visible through the user interface. As a developer, you can use universal names in a program when you don't want to change a name each time a solution is localized. Use the FieldFormula property to get a formula using local syntax. Use the FieldFormulaU property to get a formula using universal syntax.