DZConfig Methods

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

Syntax

GetSubpageName()

Description

Use the GetSubpageName method to return the name of the subpage configured for the drop zone associated with this DZConfig object.

Parameters

None.

Returns

A string value.

Example

import PTCS_DROPZONE:*;

Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
Local PTCS_DROPZONE:DZConfig &dzConfig = &dzCompConfig.AddConfig("EX_SHEET_HDR_FL", "2");

Local string &sSBPName = &dzConfig.GetSubpageName();

Syntax

RemoveDZConfiguration()

Description

Use the RemoveDZConfiguration method to remove the configuration of a subpage for the drop zone associated with this DZConfig object.

Parameters

None.

Returns

A boolean value: True if a subpage was configured for the drop zone; False otherwise.

Example

import PTCS_DROPZONE:*;

Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
Local PTCS_DROPZONE:DZConfig &dzConfig = &dzCompConfig.AddConfig("EX_SHEET_HDR_FL", "2");

Local boolean &bRet = &dzConfig.RemoveDZConfiguration();

Syntax

Save()

Description

Use the Save method to save any configuration changes for this drop zone. Invoke Save after specifying the subpage for the configuration using the SetSubPageName method. If the drop zone is being reconfigured with a new subpage, then the save operation removes the previous configuration before saving the new.

Parameters

None.

Returns

A boolean value: True if the configuration is valid; False otherwise (for example, no subpage configured).

Example

Local boolean &bRet = &dzConfig.Save();

Syntax

SetSubpageName(SUBPAGE_NAME)

Description

Use the SetSubpageName method to configure the specified subpage to this drop zone. Subsequently, invoke the Save method to save the drop zone configuration.

Parameters

Parameter	Description
`SUBPAGE_NAME`	Specifies the name of the subpage as a string value.

Returns

A boolean value: True if the specified subpage is valid; False otherwise.

Example

import PTCS_DROPZONE:*;

Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
Local PTCS_DROPZONE:DZConfig &dzConfig = &dzCompConfig.AddConfig("EX_SHEET_HDR_FL", "2");

If &dzConfig.SetSubPageName("MY_SUBPAGE_SBF") Then
   Local boolean &bRet = &dzConfig.Save();
Else
   /* Indicate that the set operation failed. */
End-If;