Version

xamOutlookBar - Recordable Methods

xamOutlookBar Test Object Recordable Methods Summary

Recordable methods summary chart

The following table briefly explains the recordable methods for testing the control. Detailed information about the methods is provided in the text blocks following the table.

Method Description

Clicks on the overflow area button to close the configuration overflow menu.

Clicks on the navigation pane toggle button to hide the content of the selected group.

Clicks on the toggle button to maximize the control.

Clicks on the toggle button to minimize the control.

Sets new height and width to the popup window that displays the group content.

Sets new width of the xamOutlookBar.

Selects the clicked xamOutlookBar group.

Sets the xamOutlookBar NavigationAreaMaxGroups property. The navigation area is resized accordingly. The effect is similar to the effect of the horizontal splitter drag operation.

Clicks on the overflow area button to open the configuration overflow menu.

Clicks on the navigation pane toggle button to display the content of the selected group.

HideOverflowContextMenu Method

Description

This method records and replays the closing of the configuration overflow context menu in the xamOutlookBar overflow area.

Details

No additional details.

Parameters

No parameters are used with this method.

Example

Closing of the overflow context menu:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").HideOverflowContextMenu

Default setting

No default setting.

Possible exceptions

No known exceptions.

HideSelectedGroupContent Method

Description

This method records and replays the hiding of the popup window with the content of the currently selected group when the xamOutlookBar is minimized.

Details

No additional details.

Parameters

No parameters are used with this method.

Example

Hiding the popup window with selected group content in xamOutlookBar:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").HideSelectedGroupContent

Default setting

No default setting.

Possible exceptions

The following table lists the possible exceptions for the method and the reason that is likely to be causing them.

Exception name Exception description Possible reasons

Cannot perform the specified action ["since either the OutlookBar is not minimized or not allowed to minimize"].

The xamOutlookBar popup window can’t be hidden when replaying the method.

The xamOutlookBar AllowMinimized property is set to False.

MaximizeOutlookBar Method

Description

This method records and replays the maximizing action performed by the user on the xamOutlookBar control.

Details

No additional details.

Parameters

No parameters are used with this method.

Example

Expanding the xamOutlookBar navigation pane:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").MaximizeOutlookBar

Default setting

No default setting.

Possible exceptions

No known exceptions.

MinimizeOutlookBar Method

Description

This method records and replays the minimizing action performed by the user on the xamOutlookBar control.

Details

No additional details.

Parameters

No parameters are used with this method.

Example

Minimizing the xamOutlookBar navigation pane:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").MinimizeOutlookBar

Default setting

No default setting.

Possible exceptions

The following table lists the possible exceptions for the method and the reason that is likely to be causing them.

Exception name Exception description Possible reasons

Cannot perform the specified action ["since OutlookBar is not allowed to minimize"].

The xamOutlookBar can’t be minimized when replaying the method.

The xamOutlookBar AllowMinimized property is set to False.

ResizeGroupContent Method

Description

This method records and replays the resizing of the popup window with the content of the currently selected group when the xamOutlookBar is minimized.

Details

The event of dragging the popup resizer bar is recorded after the drag is completed. This action is recorded only if the height/width of the popup has changed.

The replay is executed with setting the new recorded width and height to the popup window.

Parameters

The following table explains the method’s parameters along with some sample code.

Method Parameters Description

• The new height (default)

• The new width (default)

Example

Resizing the popup window’s height to 290 and its width to 340:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").ResizeGroupContent 290, 340

Default setting

This action is recorded with the new height and width of the content popup window as parameters.

Possible exceptions

The following table lists the possible exceptions for the method and the reason that is likely to be causing them.

Exception name Exception description Possible reasons

Cannot perform the specified action.

Replaying the method throws an exception because the xamOutlookBar is not minimized or the minimizing is not allowed.

  • The xamOutlookBar AllowMinimized property is set to False

  • The xamOutlookBar is not minimized.

  • Unable to set the new height and width of the content popup window

ResizeOutlookBar Method

Description

This method records and replays the resizing the width of the xamOutlookBar control.

Details

The event of dragging the vertical splitter is recorded after the drag is completed. The replay is executed with setting the new recorded width to the xamOutlookBar control.

Parameters

The following table explains the method’s parameter along with some sample code.

Method Parameter Description

The new xamOutlookBar width (default)

Example

Resizing the width of the xamOutlookBar:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").ResizeOutlookBar 260

Default setting

This action is recorded with the new width of the xamOutlookBar as a parameter.

Possible exceptions

The following table lists the possible exceptions for the method and the reason that is likely to be causing them.

Exception name Exception description Possible reasons

"Vertical Splitter" is not visible

If the xamOutlookBar property IsVerticalSplitterVisible is set to False, the control resizing cannot be performed.

• The xamOutlookBar vertical splitter is not visible

SelectGroup Method

Description

The Selec Group t method selects the clicked group. It records and replays the group selection action performed by the user.

Details

When the group selection is recorded, the method takes as a parameter either the group header text or the group index, depending on whether there are duplicating group headers’ texts. The following selection logic applies:

  • If the header text is unique, the group header text is used as a parameter.

  • If the header text is not unique, the group index is used for every duplicating header text.

Parameters

The following table explains the method’s parameters together with some sample code.

Method Parameter Description

Group header text

(default)

Used if the header text is unique or it is the first occurrence of a duplicated header text (i.e. the first group with a non-unique header).

Example

Selecting the first group with header “Mail” and index 0 in the xamOutlookBar:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").SelectGroup "Mail"

Group index

Used if the header text is not unique after the first occurrence of the non-unique header text (i.e. for all groups with non-unique headers after the first one).

Example

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").SelectGroup 0

Default setting

The group selection action is recorded with the group header text passed as a parameter.

Possible exceptions

The following table lists the possible exceptions for the method and the reason that is likely to be causing them.

Exception name Exception description Possible reasons

The following OutlookBar Item was not found.

The selected group cannot be located when replaying the method.

  • The group has been removed, collapsed or hidden

  • The group is in the closed overflow context menu and is still invisible.

  • The xamOutlookBar is minimized and the group is in the overflow area is therefore still invisible.

SetNavAreaMaxGroups Method

Description

This method records and replays the dragging of the xamOutlookBar horizontal splitter and resizing the navigation area by adjusting the count of visible groups in it. This action also changes the number of groups in the context menu and oveflow area.

Details

No additional details.

Parameters

The following table explains the method’s parameter along with some sample code.

Method Parameter Description

The maximum number of groups visible in the navigation area (default)

Example

Resizing the xamOutlookBar navigation area to 3 visible groups:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").SetNavAreaMaxGroups 3

Default setting

This action is recorded with the new maximum count of visible groups in the navigation area as a parameter.

Possible exceptions

The following table lists the possible exceptions for the method and the reason that is likely causing them.

Exception name Exception description Possible reasons

Cannot perform the specified action.

Replaying the method throws an exception.

Unable to set the NavigationAreaMaxGroups property.

ShowOverflowContextMenu Method

Description

This method records and replays the opening of the configuration overflow context menu in the xamOutlookBar overflow area.

Details

No additional details.

Parameters

No parameters are used with this method.

Example

Opening of the overflow context menu:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").ShowOverflowContextMenu

Default setting

No default setting.

Possible exceptions

No known exceptions.

ShowSelectedGroupContent Method

Description

This method records and replays the opening of the popup window with the content of the currently selected group.

Details

No additional details.

Parameters

No parameters are used with this method.

Example

Expanding the hidden group content in xamOutlookBar:

WpfWindow("MainWindow").XamOutlookBar("xamOutlookBar").ShowSelectedGroupContent

Default setting

No default setting.

Possible exceptions

No known exceptions.

Related Topics

The following table lists other topics you may find useful.

Topic Purpose

This topic provides information about the user actions of the xamOutlookBar™ control which you can test and the elements you can inspect.

This topic provides reference information about the replay-only user methods for testing the xamOutlookBar™ control.

This topic provides reference information about the test object properties of the xamOutlookBar™ control that can be inspected.

This topic provides reference information about the proxy class that supports the testing of the xamOutlookBar™ control in Micro Focus Unified Functional Testing software.