Provides access to the Spotfire library.
An instance of this class is available as a service on the user level.
Inheritance Hierarchy
Spotfire.Dxp.Framework.LibraryLibraryManager
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 sealed class LibraryManager
The LibraryManager type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Links |
Gets a collection of methods for retrieving library items uri of different types.
|
Methods
| Name | Description | |
|---|---|---|
 | Copy | Copy one or more library items to the specified folder.
If an item to copy is a folder, all contained items and folders are included.
The items and any descendants will all be given new IDs.
All ancestors will also be updated with a new "Updated By Principal" and "Updated Timestamp".
If an error occurs all changes will be rolled back. |
| CreateFolder |
Creates a folder with the specified folderName in the library. The folder is created under the
specified parentFolder.
|
| Delete |
Deletes the specified item in the library.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Move | Move one or more library items to the specified folder.
If an item to move is a folder all contained items and folders are included.
All ancestors will also be updated with a new "Updated By Principal" and "Updated Timestamp".
If an error occurs all changes will be rolled back. |
| Search |
Gets a collection of items matching the specified search expression.
|
| SetLibraryItemMetadata | Sets the metadata of an existing library item.
Only the properties explicitly set in metadata object will be updated.
To keep old values of Description, Keywords or Properties, do not set those properties. |
| SetLibraryItemTitle | Sets the title of an existing library item. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryGetItem(Guid, LibraryItem, LibraryItemRetrievalOption) |
Tries to get the item associated with the specified id. Returns true if the item is found and
false otherwise.
On success, the item parameter is assigned and populated according to the
specified metadata options.
|
| TryGetItem(String, LibraryItemType, LibraryItem, LibraryItemRetrievalOption) |
Tries to get the item associated with the specified path. Returns true if the item is found and
false otherwise.
On success, the item parameter is assigned and populated according to the
specified metadata options.
|
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