DZComponentConfig Methods
In this section, the DZComponentConfig class methods are presented in alphabetical order.
Syntax
AddConfig(PAGE_NAME, FldTabOrder)Description
Use the AddConfig method to instantiate a DZConfig object to add a new drop zone configuration or to retrieve an existing configuration for a drop zone group box. Subsequently, use the SetSubpageName and then the Save methods of the DZConfig object to associate a subpage to this drop zone and save the configuration.
Parameters
Parameter |
Description |
|---|---|
PAGE_NAME |
Specifies a string value representing the name of a main page, a nested subpage, or a secondary page that contains a valid drop zone group box. Note: To be valid, the page containing the valid drop zone group box must be definitional linked to the component that is associated with this DZComponentConfig object. |
FldTabOrder |
Specifies the page field tab order for the group box as a string value. |
Returns
A DZConfig object.
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");
Syntax
DZComponentConfig(COMPONENT_NAME, MENU_NAME, MKT)Description
Use the DZComponentConfig constructor method to instantiate a DZComponentConfig object that is used to add, update, or remove drop zone configurations for the specified component.
Parameters
Parameter |
Description |
|---|---|
COMPONENT_NAME |
Specifies the name of the component containing drop zones as a string value. |
MENU_NAME |
Specifies the name of the menu to which the component is registered as a string value. |
MKT |
Specifies the name of the market to which the component is registered as a three-character string value. |
Returns
A DZComponentConfig object.
Example
import PTCS_DROPZONE:*;
Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
Syntax
GetConfigurationsForComponent()Description
Use the GetConfigurationsForComponent method to retrieve all existing drop zone information and configurations for the component as an array of DZConfig objects. This array includes drop zones that are configured with subpages and drop zones that are not yet configured. The array is available through the arrDZInfo property.
Parameters
None.
Returns
None.
Example
import PTCS_DROPZONE:*;
Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
&dzCompConfig.GetConfigurationsForComponent();
Local integer &i;
For &i = 1 To &dzCompConfig.arrDZInfo.Len
/* Do something with the fetched drop zones. */
Local PTCS_DROPZONE:DZConfig &assignDZInfo = &dzCompConfig.arrDZInfo [&i];
If &assignDZInfo.GetSubpageName() = "" Then
If &assignDZInfo.SetSubpageName("MY_SUBPAGE_SBF") Then
Local boolean &bRet = &assignDZInfo.Save();
Else
/* Indicate that the set operation failed. */
End-If;
End-If;
End-For;Syntax
GetConfigurationsForPage(PAGE_NAME)Description
Use the GetConfigurationsForPage method to retrieve all existing drop zone information and configurations for the specified page as an array of DZConfig objects. This array includes drop zones that are configured with subpages and drop zones that are not yet configured. The array is available through the arrDZInfo property.
Parameters
Parameter |
Description |
|---|---|
PAGE_NAME |
Specifies a string value representing the name of a main page, a nested subpage, or a secondary page that contains a valid drop zone group box. Note: To be valid, the page must be definitional linked to the component that is associated with this DZComponentConfig object. |
Returns
None.
Example
import PTCS_DROPZONE:*;
Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
&dzCompConfig.GetConfigurationsForPage("EX_SHEET_HDR_FL");
Local integer &i;
For &i = 1 To &dzConfig.arrDZInfo.Len
/* Do something with the fetched drop zones. */
End-For;
Syntax
GetConfigurationsForPagefield(PAGE_NAME, FldTabOrder)Description
Use the GetConfigurationsForPagefield method to retrieve any existing drop zone information and configuration for the specified page and page field as an array of DZConfig objects. For a page field, this array includes one element, because only one drop zone can be associated with a page field. The array is available through the arrDZInfo property.
Parameters
Parameter |
Description |
|---|---|
PAGE_NAME |
Specifies a string value representing the name of a main page, a nested subpage, or a secondary page that contains a valid drop zone group box. Note: To be valid, the page containing the valid drop zone group box must be definitional linked to the component that is associated with this DZComponentConfig object. |
FldTabOrder |
Specifies the page field tab order for the group box as a string value. |
Returns
None.
Example
import PTCS_DROPZONE:*;
Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
&dzCompConfig.GetConfigurationsForPagefield("EX_SHEET_HDR_FL", "2");
Local integer &i;
For &i = 1 To &dzConfig.arrDZInfo.Len
/* Do something with the fetched drop zone. */
End-For;
Syntax
GetConfigurationsForSubpage(SUBPAGE_NAME)Description
Use the GetConfigurationsForSubpage method to retrieve all existing drop zone configurations for the component that have been configured with the specified subpage. The configurations are returned as an array of DZConfig objects available through the arrDZInfo property.
Note: A given subpage can be configured to one or more drop zones within the same component.
Parameters
Parameter |
Description |
|---|---|
SUBPAGE_NAME |
Specifies the name of the subpage as a string value. |
Returns
None.
Example
import PTCS_DROPZONE:*;
Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
&dzCompConfig.GetConfigurationsForSubpage("MY_SUBPAGE_SBF");
Local integer &i;
For &i = 1 To &dzConfig.arrDZInfo.Len
/* Do something with the fetched drop zones. */
End-For;
Syntax
RemoveAllConfigForComponent()Description
Use the RemoveAllConfigForComponent method to delete all drop zone configurations for this component.
Parameters
None.
Returns
None.
Example
import PTCS_DROPZONE:*;
Local PTCS_DROPZONE:DZComponentConfig &dzCompConfig = create PTCS_DROPZONE:DZComponentConfig("EX_EXP_SHEET_FL", "EX_ADMIN_EXPENSE_FL", "GBL");
&dzCompConfig.RemoveAllConfigForComponent();