_Explorer.AddToSelection(Object) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Adds the specified Microsoft Outlook item to the selection in the active explorer.
public:
void AddToSelection(System::Object ^ Item);public void AddToSelection (object Item);Public Sub AddToSelection (Item As Object)Parameters
- Item
- Object
The item to add to the selection in the active explorer.
Remarks
The selection in the active explore is represented by the Selection object that is returned by the Selection property.
To be selected, the item must be selectable in the current view of the active explorer. Use the IsItemSelectableInView(Object) method to determine whether the item can be selected in the view. The item does not have to be visible in the view.
Under the following conditions, Outlook returns an error when you call the AddToSelection method:
If the item is not selected and is selectable in the current view, calling AddToSelection causes the SelectionChange event to fire.
Calling AddToSelection does not scroll the view to make the selected item visible in the view and does not expand or collapse groups in the view.
The following table illustrates the results of calling AddToSelection, taking into consideration any current selection (the Count property) and whether the Reading Pane is displayed.
| 0 | Yes | The item is added to the selection.SelectionChange fires.Reading Pane displays the item. | |
| 0 | No | The item is added to the selection.SelectionChange fires. | |
| >=1 | Yes | The item is added to the selection.SelectionChange fires.Reading Pane does not change the item it displays unless the view is a Calendar view, in which case, calling AddToSelection can cause the Reading Pane to display a different item. | |
| >=1 | No | The item is added to the selection.SelectionChange fires. |
If the specified item is already selected in the active explorer, calling AddToSelection does not result in any change to the selection and the SelectionChange event does not fire.
When you specify an item in a recurring appointment or task as an argument to the AddToSelection method, make sure that before you pass the argument, you obtain an instance of the occurrence by first expanding the recurrences, using the IncludeRecurrences property and the Items collection. If you do not expand the recurrences and obtain an occurrence in the series, you pass an instance variable that represents the appointment or task series, and the AddToSelection method operates on the series instead of the occurrence.
Note that you can use AddToSelection to add items to a selection, but you cannot add conversation headers to a selection.