GridDataComposition: Apply Grid Configuration from File

Tag: GridDataComposition

The GridDataComposition action will apply a previously saved grid configuration file to a grid. It can also run the content of such a file directly within your script.
Grid configuration files contain information about the grid layout, its options, the order of columns, their formats, grouping, sorting etc.


XML
<GridDataComposition FilePath="C:\dev\Temp_XML\mainGridConfig.xml"/>

Tag Attributes

Attributes

Attribute Values

Value Description

Target

The corresponding 

Grid Code

Sets the target grid on which to carry out the action - Not Required. If no target is set, the target will default to the main grid (for products containing a main grid).

FilePath

User definable

The folder path that contains the Grid Data Composition XML file

FrozenColumnID

Applicable Column ID in the 

Grid Manager

Sets the horizontal scrolling freeze of the grid at that column position.

If the column is not found, the column at position FrozenColIndex is set as the frozen column, if provided, 

FrozenColIndex

Position of column to freeze

Sets the horizontal scrolling freeze of the grid at that column position.

Reset

UserDefault

YtriaDefault

Will return the grid to the specified default setting - Not Required

Server

Abbreviated server names (separated by comma)

N/A - Only applicable in consoleEZ

Index

Positive integer

Window index number - Only applicable in consoleEZ


When using the attribute FilePath to retrieve incoming files, it will validate if both the folder path is correct and that the file itself exists.

Example Script

XML
<YtriaAutomation>
	<Load Server="Acme01/ACME" partial="true">
		<Load Database="AutoTest\Im_us_8.nsf" Select="True"/>
		<Load Database="AutoTest\Im_nab_8.nsf" Select="True"/>
		<Load Database="AutoTest\info_s03.nsf" Select="True"/>
		<Load Database="storebackup.ntf" Select="True"/>
	</Load>

	<GridDataComposition FilePath = "C:\dev\Temp_XML\ConfigGrid1.xml"/>
 	
</ytriaautomation­>