Version

xamDataPresenter - Excel Style Filtering

Topic Overview

Purpose

This topic provides information about recordable actions for testing the Excel Style Filtering with the xamDataPresenter.

XamDataPresenter Recordable Actions

OpenFilterDropDown

Description

Opens the filter drop down for the supplied header

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible

CloseFilterDropDown

Description

Close the filter drop down for the supplied header

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible

FilterMenuNavigation

Description

Open the filter drop down for the supplied header if not already open, and navigate to the supplied FilterMenuItem and click on it.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

oItemArg

Menu item path to the desired menu item.

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible

  • DropDown Button is not dropped down.

  • The specified index [oItemArg] is out of range

FilterTreeItemExpand FilterTreeItemCollapse FilterTreeItemCheck FilterTreeItemUnCheck

Description

Set the state for the identified filter tree item accordingly

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible

  • The specified index [oItemArg] is out of range

FilterTreeAccept

Description

Clicks OK on the Excel style Filter Menu, accepting the changes to the filter.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible

FilterTreeCancel

Description

Clicks Cancel on the Excel style Filter Menu, accepting the changes to the filter.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible

FilterTreeSearch

Description

Set the search criteria for the tree in the Excel Style Filtering filter drop down.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sHeaderArg

string text path to the header containing the filter button

sSearchText

String of text to enter into the Excel style filter search textbox.

Possible exceptions

  • This action can only be used with the FilterUI Type [LabelIcon]

  • {sHeaderArg | LabelIcon} is not visible