FieldFormula Property [Visio 2003 SDK Documentation]

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

strRet = object**.FieldFormula**

strRet    String. The formula of the custom field.

object     Required. An expression that returns a Characters object.

Version added

3.0

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 Microsoft Visio 2000, you can use both local and universal names to refer to Visio shapes, masters, documents, pages, rows, add-ons, cells, hyperlinks, styles, fonts, master shortcuts, UI objects, and layers. When a user names a shape, for example, the user is specifying a local name. Beginning with Microsoft Office Visio 2003, the ShapeSheet spreadsheet displays only universal names in cell formulas and values. (In prior versions, universal names were not visible in 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 in local syntax. Use the FieldFormulaU property to get a formula in universal syntax.

Applies to | Characters object