Gets a collection of items matching the specified search expression.
Namespace: Spotfire.Dxp.Framework.Library
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
public LibraryItemCollection Search( string searchExpression, params LibraryItemRetrievalOption[] retrievalOptions )
Parameters
- searchExpression
- Type: SystemString
An expression describing the items that shall be returned. The syntax used is the same as in the search field in the "Open from Library" dialog. See the topic "Searching the Library" in the Spotfire User´s Guide for a description of the search syntax. - retrievalOptions
- Type: Spotfire.Dxp.Framework.LibraryLibraryItemRetrievalOption
Specifies the kinds of metadata that the returned items shall be populated with.
Return Value
Type: LibraryItemCollectionA collection of items matching the search.
Exceptions
Exception | Condition |
---|---|
LibraryException | If an error occurs in the communication with the library. |
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also