GetFormAttrib

Use this function to return the content of the named user attribute (metadata) for the form you specify.

Syntax

GetFormAttrib (Name, Form, Group)

If you omit both the Form and Group parameters, the system chooses the current form, based on where the script executes. During Entry (via the Documaker Desktop or the plug-in) this will be the form that contains the DAL script. During Documaker Server processing, the first logical form found within the document set is the current form, unless the script is executed from a section or field rule.

If you include the Form parameter, but omit the Group parameter, the system looks for the form within the current group of forms, as defined by where the script executes. During Entry (via the Documaker Desktop or the WIP Edit plug-in) this is the group that contains the form where the script executes. During Documaker Server processing, the first logical group found within the document set is the current group, unless the script is executed from a section or field rule.

If you omit the Form parameter but include the Group parameter, the system locates the first form within the group you specified.

If you define an attribute, form, or group that is not included in the current document, the system returns an empty string.

Example

For the following examples assume that form 1111 has the following metadata. Also assume form 9999 was not selected or triggered.

Here is the first example:

xx = GetFormAttrib("Offer", "1111")

In this example the variable xx is set to:

Good until cancelled

Here is another example:

xx = GetFormAttrib("Codes", "9999")

In this example the variable xx is set to an empty string.

See also

• PutFormAttrib
• Have Functions

© Copyright 2017, Oracle and/or its affiliates. All rights reserved. Legal Notices

Open table of contents