ConfigureGrid: Apply a Saved Grid Configuration XML File
Tag: ConfigureGrid
The ConfigureGrid function performs directly within the current script what GridDataComposition does from a grid XML config file.
GridDataCompositon forces you to save your grid composition, and then to load the file. This results in you to having one file for the automation and one file for the grid composition.
Configuregrid allows you to keep the grid config inside the main script directly.
<ConfigureGrid/>Tag Attributes
| Attributes | Value Description |
|---|---|
| Target | Uniquely identifies the grid (see each product’s grid codes). Not required (then addresses the main grid or the current frame grid) |
| 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 | Sets the horizontal scrolling freeze of the grid at that column position. |
Also uses all parameters found in a grid XML GridDataComposition action.
Tag: ConfigureColumn
The ConfigureColumn tag allows you to embed such grid composition directly inside of your automation (rather than linking to an external file).
| Attributes | Value Description |
|---|---|
| CoulmnID | Column UID - Required |
Also uses all parameters found in a grid XML GridDataComposition action and all the associated sub-actions.(SetPAram, SetColumnFormat, Filter).
- The param Title is ignored in regular automation
- The order of ConfigureColumn actions is not relevant (in a grid XML, it indicates the column position - in a regular script it does not matter)
- It may be wise to use <SuspendRedraw value="true"/> and <SuspendRedraw value="false"/> to save on grid udpate time if several of these actions are used in a row.
Detailed Description
How to use:
- Open a grid XML file
- Copy the GridDataComposition as a ConfigureGrid action, if grid cfg is wanted and paste into your regular XML script
- Copy each AddColumn block as a ConfigureColumn action if column cfg is wanted and paste into your regular XML script
- Try it
ConfigureColumn actions are not expected to be embedded in a ConfigureGrid action.
One ConfigureColumn tag is required for each column that is to be set as visible. All columns that are not configured via ConfigureColumn are hidden.
Example Script
<ytriaAutomation>
<SuspendRedraw value="true"/>
<ConfigureGrid ColIDSortGroupingsBySummary="-1" DisplayMode="0" FrozenColIndex="2" GCVDIsMinimized="True" Grid="MessagesGrid" GridDataCompositionVersion="17" GroupsAndTools="True"
HighlightSelectedColumns="False" SetHierarchyView="False" SetTravelSelection="True" ShowColumnTitle="False" ShowEmptyGroups="False" ShowFocusColTooltip="False"
ShowGroupCounters="True" ShowSingleRowGroups="True" ShowStatusBar="True" SortGroupingsByCount="False" SortGroupingsBySummary="False" SortMultivaluesByCount="False"
StatusBarFlags="30" Width="250"/>
<ConfigureColumn ColumnID="sender" TitleDisplayed="From">
<SetParam Visible="True"/>
<SetParam Autoresize="False"/>
<SetParam ForceAlphaSort="False"/>
<SetParam Width="100"/>
<SetColumnFormat Type="TFMTGrouping"/>
<SetColumnFormat Type="NFMTGrouping"/>
<SetColumnFormat CBX_FMT_CBXSortFlag="0" Type="CheckBoxFmtGrouping"/>
<SetColumnFormat TextAlignment="0" TextCase="0" TextColor="4294967295" TextNotesName="False" Type="TextFmtGroup"/>
<SetColumnFormat TextAlignment="0" TextCase="0" TextColor="4294967295" TextNotesName="False" Type="TextFmtGroupSummary"/>
<SetColumnFormat Type="TFMTRegular"/>
<SetColumnFormat Type="NFMTRegular"/>
<SetColumnFormat CBX_FMT_CBXSortFlag="0" Type="CheckBoxFmtRegular"/>
<SetColumnFormat Type="HyperlinkFmtRegular"/>
<SetColumnFormat TextAlignment="0" TextCase="0" TextColor="4294967295" TextNotesName="False" Type="TextFmtRegular"/>
<Filter Applied="False" Enabled="True" Mode="Regex" Regex=""/>
<Filter Mode="Empty"/>
<Filter Applied="False" Begins="" Contains="" Enabled="False" Ends="" Equals="" Mode="Text" NotBegins="" NotContains="" NotEnds="" NotEquals=""/>
<Filter Applied="False" Enabled="True" Equals="" GreaterOrEquals="" GreaterThan="" LessOrEquals="" LessThan="" Mode="Number" NotEquals=""/>
<Filter Applied="False" Enabled="False" Equals="" GreaterOrEquals="" GreaterThan="" LessOrEquals="" LessThan="" Mode="Date" NotEquals=""/>
<Filter Applied="False" Enabled="False" Equals="" GreaterOrEquals="" GreaterThan="" LessOrEquals="" LessThan="" Mode="Time" NotEquals=""/>
<Filter Applied="False" Days="" Enabled="False" Hours="" Minutes="" Mode="LastFrom" Months="" Years=""/>
</ConfigureColumn>
<UpdateGrid/>
</ytriaAutomation >