DZPage Methods

In this section, the DZPage class methods are presented in alphabetical order.

Syntax

DZPage(PAGE_NAME)

Description

Use the DZPage constructor method to instantiate a DZPage object that is used to get drop zone configurations by component for this page or secondary page.

Parameters

Parameter	Description
`PAGE_NAME`	Specifies a string value representing the name of a main page that contains a valid drop zone group box, or a main page that contains a subpage that contains a valid drop zone group box, or a secondary page that contains a valid drop zone group box.

Returns

A DZPage object.

Example

import PTCS_DROPZONE:*;

Local PTCS_DROPZONE:DZPage &dzPage = create PTCS_DROPZONE:DZPage("EX_SHEET_HDR_FL");

Syntax

GetConfigurationFromPageField(FldTabOrder)

Description

Use the GetConfigurationFromPageField method to return the drop zone configurations for the specified page field as an array of DZComponentConfig objects.

Parameters

Parameter	Description
`FldTabOrder`	Specifies the page field tab order for the drop zone group box as a string value.

Returns

An array of DZComponentConfig objects.

Example

import PTCS_DROPZONE:*;

Local PTCS_DROPZONE:DZPage &dzPage = create PTCS_DROPZONE:DZPage("EX_SHEET_HDR_FL");
Local array of PTCS_DROPZONE:DZComponentConfig &arrDzConfig = &dzPage.GetConfigurationFromPageField("2");

Local integer &i;
For &i = 1 To &arrDzConfig.Len
   /* Do something with the fetched configurations. */
End-For;

Syntax

GetConfigurationFromPageName()

Description

Use the GetConfigurationFromPageName method to return the drop zone configurations for the current page as an array of DZComponentConfig objects.

Parameters

None.

Returns

An array of DZComponentConfig objects.

Example

import PTCS_DROPZONE:*;

Local PTCS_DROPZONE:DZPage &dzPage = create PTCS_DROPZONE:DZPage("EX_SHEET_HDR_FL");
Local array of PTCS_DROPZONE:DZComponentConfig &arrDzConfig = &dzPage.GetConfigurationFromPageName();

Local integer &i;
For &i = 1 To &arrDzConfig.Len
   /* Do something with the fetched configurations. */
End-For;