You are here: Function Reference > Alphabetical Listing > P > PageSection

PageSection

PageImage

PageImage has been replaced with PageSection. PageSection and PageImage have same functionality; the only change is to the function name. The existing PageImage scripts will continue to function and will not require any modification.

Use this function to return the name of a section on a given page number within the form set or form. If you include the name of a recipient as a parameter, the system will filter the sections by that name. Once you have a section name, you can use other DAL functions to query the section, to insert a new section, or to delete the section.

Syntax

PageSection (Page, Recipient, Form, Group)

Parameter

Description

Page

Include this parameter to indicate the specific page where you want to locate a section. If you omit this parameter, a section from page one is located. Depending upon the remaining parameters, this page will be the page within the entire form set, or within a given form.

Recipient

Include this parameter to filter the sections located by that recipient. If you omit this parameter, the name of the first section on the requested page is returned.

Form

Include this parameter if you want the system to first locate the specified form and then use the Page parameter to find the specified page within that form. If you omit this parameter, the Page parameter is based on a page located by starting at the first page of the form set or group (if the Group parameter is specified).

Group

Include this parameter to tell the system to first locate a specific group. If you also include the Form parameter, the system will find that form in that group. If you omit the group but include the form, the system looks for that form in the current group — which is identified by the current field or section executing the script. If you include the group but omit the form, the system uses the Page parameter to return that page in the specified group.

The name returned by this function also includes the occurrence value if the section occurs more than once. For instance, if a section named, MySection, is located on the given page, but this is the second occurrence of the section within the named form, the name returned will be MySection\2.

See also