SetListColumns: Create a list of grid column unique IDs and titles

Tag: SetListColumns

The action SetListColumns function creates a list of variables (SetVar) with the UIDs and Displayed Titles of each column.

Detailed Description

The column selection can be reduced to:

Comments only
Visible columns only

And can include system column or not. By default, system columns are not included.

Each entry in the resulting list of columns contains one SetVar action with variables:

ColumnID: UID of the column
TitleDisplayed: title currently shown in its header in the grid
Comment: True or False
Technical: True or False
Visible: True or False
Category: title of column category

Tag Attributes

Attributes	Value Description
ListName	List name - Required
Target	Grid target name - Required according to context (like any other grid action)
CommentsOnly	TRUE / FALSE Defaults to FALSE
VisibleOnly	TRUE / FALSE Defaults to FALSE
WithSystem	TRUE / FALSE Defaults to FALSE
Verbose	TRUE / FALSE Defaults to TRUE Prints out the list content in the trace.

Example script

XML

<ytriaAutomation console="false"> 

	<SetListColumns ListName="COMMENTS" CommentsOnly="True"/>	
	<SetListColumns ListName="VISIBLECOMMENTS" CommentsOnly="True" VisibleOnly="True"/>
	<SetListColumns ListName="ALL"/>
	<SetListColumns ListName="VISIBLE" VisibleOnly="True"/>
	<SetListColumns ListName="VISIBLEANDSYSTEM" VisibleOnly="True" WithSystem="true"/>
	
	<Echo value="*************** COMMENTS *******************"/>
	<Loop list="COMMENTS">
		<ExecuteListAction/>
	</Loop>

	<Echo value="*************** VISIBLECOMMENTS *******************"/>
	<Loop list="VISIBLECOMMENTS">
		<ExecuteListAction/>
	</Loop>

	<Echo value="*************** VISIBLE *******************"/>
	<Loop list="VISIBLE">
		<ExecuteListAction/>
	</Loop>

	<Echo value="*************** VISIBLEANDSYSTEM *******************"/>
	<Loop list="VISIBLEANDSYSTEM">
		<ExecuteListAction/>
	</Loop>
	
	<Echo value="*************** ALL *******************"/>
	<Loop list="ALL">
		<ExecuteListAction/>
	</Loop>
	
</ytriaAutomation>

For this grid with 2 Comments, one being hidden:

etc.