List Class Properties

In this section, the List class properties are presented in alphabetical order.

Description

Use this property to set or return a string value representing the name of the application class that contains the method to be invoked at activity guide instance creation.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath, AppClassID, and AppClassMethod

This property is read/write.

Description

Use this property to set or return a string value representing the name of the method to be invoked at activity guide instance creation.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath, AppClassID, and AppClassMethod

This property is read/write.

Description

Use this property to set or return the description for the activity guide as a string value.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the first configurable text field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the fifth configurable yes/no field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the second configurable text field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the third configurable text field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the fourth configurable text field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the fifth configurable text field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the first configurable yes/no field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the second configurable yes/no field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the third configurable yes/no field.

This property is read/write.

Description

Use this property to set or return a string value representing the label for the fourth configurable yes/no field.

This property is read/write.

Description

Use this property to set or return a string value representing the URL for the WorkCenter page (or starting page) that incorporates this activity guide. This URL provides access from the Activity Guides - In Progress homepage pagelet to the WorkCenter page.

This property is read/write.

Description

Use this property to set or return a Boolean value indicating whether the activity guide is active.

This property is read/write.

Description

Use this property to set or return a Boolean value indicating whether the activity guide is a template. When this property is False, the List object is an activity guide instance.

This property is read/write.

Description

Use this property to set or return a string representing the descriptive name (or title) of the activity guide.

This property is read/write.

Description

Use this property to return a string representing the ID for this activity guide.

This property is read-only.

Description

Use this property to set or return a string value representing the name of the application package that contains the method to be invoked at activity guide instance creation.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath, AppClassID, and AppClassMethod

This property is read/write.

Description

Use this property to set or return a string representing the ID of the template used to generate the activity guide instance. If the List object represents an activity guide template, then this property will be Null.

Description

Use this property to set or return a string representing the name of the application class that contains the method (or methods) to be invoked to create custom navigation frame buttons.

Note: The full path to the method is constructed from three properties: pgltPackageRoot, pgltQualifyPath, and pgltAppClass.

This property is read/write.

Description

Use this property to set or return a string representing the name of the application package that contains the method (or methods) to be invoked to create custom navigation frame buttons.

Note: The full path to the method is constructed from three properties: pgltPackageRoot, pgltQualifyPath, and pgltAppClass.

This property is read/write.

Description

Use this property to set or return a Boolean value indicating whether the progress bar will be displayed in the activity guide pagelet on the WorkCenter page.

This property is read/write.

Description

Use this property to set or return a string representing the names of each subpackage in the application class hierarchy that define the location of the application class. Separate subpackage names by a colon. If the class is defined in the top-level application package, use a colon only.

Note: The full path to the method is constructed from three properties: pgltPackageRoot, pgltQualifyPath, and pgltAppClass.

This property is read/write.

Description

Use this property to set or return a string value representing the names of each subpackage in the application class hierarchy that define the location of the application class. Separate subpackage names by a colon. If the class is defined in the top-level application package, use a colon only.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath, AppClassID, and AppClassMethod

This property is read/write.

Description

Use this property to set or return the status of the instance, which determines whether the activity guide is displayed in the Activity Guides - In Progress pagelet. The valid values are:

Value

Description

CA

Cancelled

CP

Complete

IP

In progress

This property is read/write.

Example

In the following example, the method sets the activity guide status to complete:

method CompleteStatus
   /+ &list_id as String +/
   
   Local PTAI_ACTION_ITEMS:List &ObjList;
   
   &ObjList = create PTAI_ACTION_ITEMS:List();
   &ObjList.open(&list_id);
   
   Rem set the status of the template to Complete;

   &ObjList.Status = "CP";
   &return = &ObjList.save();

end-method;