Version

WinCarousel Actions

Topic Overview

Purpose

This topic provides information about recordable actions for testing the WinCarousel ™ control.

In this topic

This topic contains the following sections:

WinCarousel Actions

ClickItem

Description

Left-button clicking on the identified item.

Parameters

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

Parameter Description

oItemArg

Argument of type String key, string Text or integer index that represents the Item to be selected.

obScrollToForeFront

[ Optional ] Boolean value representing if the item should be scrolled to forefront before clicking it (Default value = true ).

Examples

The following three lines of code (Separately) will all scroll the item to forefront and click the same carousel item.

In C#:

… SwfListView("Identifier").ClickItem 0
… SwfListView("Identifier").ClickItem “Item Text 1”
… SwfListView("Identifier").ClickItem “ItemKey1”

The following code will click the carousel item, without scrolling it to forefront.

In C#:

… SwfListView("Identifier").ClickItem “ItemKey1”, false

Possible exceptions

The following list contains the possible exceptions to this method and the likely reason causing them.

  • The index [{1}] is out of range

  • The following [{1}] was not found

SelectItem

Description

Selects the identified item.

Parameters

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

Parameter Description

oItemArg

Argument of type String key, string Text or integer index that represents the Item to be selected.

bExtendSelection

[ Optional ] Boolean value representing if the Ctrl key that should be pressed to extend selection (Default vlaue = false ).

Examples

The following three lines of code (Separately) will all click the same carousel item to select it.

In C#:

… SwfListView("Identifier").SelectItem 0
… SwfListView("Identifier").SelectItem “Item Text 1”
… SwfListView("Identifier").ClickItem “ItemKey1”

The following code will click the carousel item, adding it to the existing selection.

In C#:

… SwfListView("Identifier").SelectItem “ItemKey1”, true

Possible exceptions

The following list contains the possible exceptions to this method and the likely reason causing them.

  • The index [{1}] is out of range

  • The following [{1}] was not found

  • Selection is not enabled for the UltraCarousel

  • Extended Selection is not enabled for the UltraCarousel

DeselectItem

Description

Deselects the (selected) identified item.

Parameters

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

Parameter Description

oItemArg

Argument of type String key, string Text or integer index that represents the Item to be selected.

Examples

The following three lines of code (Separately) will all ctrl + click the same carousel item to deselect it.

In C#:

… SwfListView("Identifier").DeselectItem 0
… SwfListView("Identifier").DeselectItem “Item Text 1”
… SwfListView("Identifier").DeselectItem “ItemKey1”

The following line of code will ctrl + click the carousel item, adding it to the existing selection.

In C#:

… SwfListView("Identifier").DeslectItem “ItemKey1”, true

Possible exceptions

The following list contains the possible exceptions to this method and the likely reason causing them.

  • The index [{1}] is out of range

  • The following [{1}] was not found

  • Selection is not enabled for the UltraCarousel

SelectToItem

Description

Selects to the identified item.

Parameters

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

Parameter Description

oItemArg

Argument of type String key, string Text or integer index that represents the Item to be selected.

bExtendSelection

[ Optional ] Boolean value representing if the Ctrl key that should be pressed to extend selection (Default Vlaue = false ).

Examples

The following three lines of code (Separately) will all Shift + click the same carousel item to select it.

In C#:

… SwfListView("Identifier").SelectToItem 0
… SwfListView("Identifier").SelectToItem “Item Text 1”
… SwfListView("Identifier").SelectToItem “ItemKey1

The following code will Shift + click the arousel item, adding it to the existing selection.

In C#:

… SwfListView("Identifier").SelectToItem “ItemKey1”, true

Possible exceptions

The following list contains the possible exceptions to this method and the likely reason causing them.

  • The index [{1}] is out of range

  • The following [{1}] was not found.

  • Selection is not enabled for the UltraCarousel.

  • Extended Selection is not enabled for the UltraCarousel

WinCarousel Replay-only Actions

ScrollItemsIntoView

Description

This method scrolls the identified item into view.

Parameters

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

Parameter Description

oItemArg

Argument of type String key, string Text or integer index that represents the Item to be selected.

oPercentage

[ Optional ] Scrolls the Item to forefront. If the value is supplied, scrolls the item to the percentage of visible area.

Expected values are between 0 and 100 (Default value = null).

Possible exceptions

The following list contains the possible exceptions to this method and the likely reason causing them.

  • The index [{1}] is out of range

  • The following [{1}] was not found

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic provides information about the WinCarousel™ control’s actions that are executed when interacted by the user.

This topic provides reference information about the WinCarousel™ control’s test object properties.