Skip to main content

SetVirtualSelection

Description

Overrides the items selection with a virtual selection. Items should be valid objects, otherwise the method will throw an exception and selection will not be changed. When called while running in the desktop application, also opens the Details/Preview panes that apply to the new selection (never closes a pane the user closed themselves).

Syntax

// shellListing points to instance of IShellListing
const result = await shellListing.SetVirtualSelection(objOrFileVers);

Parameters

NameOptionalityTypeDescription
objOrFileVersRequiredArray < ObjectFileVersionParams >Array of object or file versions to select virtually.

Return type

TypeDescription
Promise < void >

Exceptions

ArgumentError - When objOrFileVers is null or undefined, or when required obj_ver/file_ver values are missing.

Error - When referenced object or file cannot be resolved.