|
Description |
Loops through the items of a list box or list view. The variable specified is updated with the current item text. With each successive loop, the next item is retrieved. The loop ends after all the elements have been browsed or when a Break is encountered. Used to perform an action on all items in a list box or list view. Important: Only
standard Windows list controls will
work with the Loop List Control action. Many applications use images or
other controls that may act like list controls but they are not native
Windows controls |
|
Declaration |
<AMLOOP TYPE="LISTCONTROL" WINDOWTITLE="text" WINDOWCLASS="text" WINDOWHANDLE="number" OBJECTNAME="text" OBJECTVALUE="text" OBJECTCLASS="text" OBJECTTYPE="text" CHECKOBJECTNAME="yes/no" CHECKOBJECTVALUE="yes/no" CHECKOBJECTCLASS="yes/no" CHECKOBJECTTYPE="yes/no" CHECKOBJECTPOSITION="yes/no" OBJECTXPOS="number" OBJECTYPOS="number" RESULTVARIABLE="text [variablename]" INCLUDE="text" EXCLUDE="text" SORT="text [options]" RESULTDATASET="text"> </AMLOOP> |
|
Example |
<AMVARIABLE NAME="VariableName1"></AMVARIABLE> |
|
General Tab Parameters |
Populate variable with item text: Specifies an already existing Automated Workflow variable that should be populated with the contents of the specified control at runtime. Variable, Required Object Selection: Drag the cursor icon to the desired control. The Window Object Browser dialog box appears.
Object Description: Select the target control by dragging the Automated Workflow icon. Then click the Edit button under Object Description to access these properties.
Window title must be: Specifies the title of the window to act on. The value is not case sensitive. This parameter supports wildcard characters (* and ?). For example "*Internet Explorer*" would include all windows containing Internet Explorer. A Window title is required because without this parameter, the action would have to search every control of every window on the system, which would take an unacceptable amount of time. To ignore the window title, use a wildcard character (* or ?); if this parameter is left blank, the action assumes it is searching for a window title that is blank. Text, Required Window class must be: Specifies the class of the window to act on. The value is not case sensitive. This parameter supports wildcard characters (* and ?). For example "*Explore*" would include all window classes containing Explore. If this parameter is left blank, the action assumes it is searching for a window class that is blank; to ignore the window class, use a wildcard character (* or ?). Text, Required Window handle must be: Specifies the handle of the window to act on. If set to 0 or omitted, this parameter is ignored. Number, Optional, Default: 0 Object type must be: When set to YES (selected), specifies that the object type parameter will be used to identify the control. If set to NO, the type of the control is ignored. Yes/No, Optional, Default: NO Object type: Specifies the type of control that should be used in the action. Valid only if Object type must be [CHECKOBJECTTYPE] is set to YES. Text, Optional, Default: (blank) Object class must be: When set to YES (selected), specifies that the object class parameter will be used to identify the control. If set to NO, the class of the control is ignored. Yes/No, Optional, Default: NO Object class: Specifies the class of control that should be used in the action. Valid only if Object class must be [CHECKOBJECTCLASS] is set to YES. Text, Optional, Default: (blank) Object name must be: When set to YES (selected), specifies that the object name parameter will be used to identify the control. If set to NO, the name of the control is ignored. Yes/No, Optional, Default: NO Object name: Specifies the name of the target control. Valid only if Object name must be [CHECKOBJECTNAME] is set to YES. Text, Optional, Default: (blank) Object value must be: When set to YES (selected), specifies that the object value parameter will be used to identify the control. If set to NO, the value of the control is ignored. Yes/No, Optional, Default: NO Object value: Specifies the value of the target control. Valid only if Object value must be [CHECKOBJECTVALUE] is set to YES. Text, Optional, Default: (blank) Object position must be: When set to YES (selected), specifies that the Position X and Position Y parameters will be used to identify the control. If set to NO, the position of the control is ignored. The X and Y coordinates specified are relative to the window specified in the Window Title [WINDOWTITLE] parameter (not the screen). Yes/No, Optional, Default: NO Object Position X: Specifies the X coordinate position of the control relative to the window specified in the Window Title [WINDOWTITLE] parameter. The parameter is ignored if Position must be [CHECKOBJECTPOSITION] is set to NO. Text, Optional, Default: (blank) Object Position Y: Specifies the Y coordinate position of the control relative to the window specified in the Window Title [WINDOWTITLE] parameter. The parameter is ignored if Position must be [CHECKOBJECTPOSITION] is set to NO. Text, Optional, Default: (blank) |
|
Advanced Tab Parameters |
Include windows: Specifies a wildcard mask representing the items to include in the loop. For example, specifying D* returns only items that begin with the letter "D". Text, Optional, Default: (blank) Exclude windows: Specifies a wildcard mask representing the items to exclude from the loop. For example, specifying Z* returns no items that begin with the letter "Z". Text, Optional, Default: (blank) Create and populate dataset: Specifies the name of a dataset to be created and populated with data from the looped list. The dataset will contain a column for each column in the list control plus an index column for the index number of the list item. Text, Optional, Default: (blank) Sorting: Specifies the sort order to be applied to the values before the loop begins. The available options are:
Text [options], Optional, Default: ("none") |
