PinItem Action (Accordion Controls)

Applies to TestComplete 14.91, last modified on July 20, 2021
This method is not supported in web tests (including cross-platform web tests) that use XPath expressions and CSS selectors to locate web elements. This method can be only used in tests that locate web objects by using internal identification properties provided by TestComplete.

Description

Simulates a click on the pin button of the specified accordion item. Depending on the Pin parameter, the item is either pinned or unpinned.

Declaration

TestObj.PinItem(ItemPin)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Item [in]    Required    Variant    
Pin [in]    Optional    Boolean Default value: True   
Result None

Applies To

The method is applied to the following object:

View Mode

To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.

Parameters

The method has the following parameters:

Item

Specifies the desired item. You can enter the item’s index (from 0) or its caption. The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk (*) corresponds to a string of any length (including an empty string), the question mark corresponds to any single character (including none). To specify more complicated parts of a caption, use regular expressions.

The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

Pin

Specifies whether to pin or unpin the accordion item.

Result Value

None.

Remarks

If the specified accordion item was not found, an error message is posted to the test log.

If the Pin parameter corresponds to the control state (for example, the Pin parameter is True and the accordion item is already pinned), the PinItem performs no actions and posts an informative message to the test log.

See Also

UnpinItem Action (Accordion Controls)

Highlight search results