Static
EqualsDetermines whether the specified object instances are considered equal.
The first object to compare.
The second object to compare.
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.
Gets a collection of methods for retrieving library items uri of different types.
Gets a collection of items matching the specified search expression.
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.
Rest
...retrievalOptions: LibraryItemRetrievalOption[]Specifies the kinds of metadata that the returned items shall be populated with.
A collection of items matching the search.
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.
The id of the item to get.
Will be assigned with the library item or null if no item with the specified id can be found.
Rest
...retrievalOptions: LibraryItemRetrievalOption[]Specifies the kinds of metadata that the returned item shall be populated with.
true if an item was found, false otherwise.
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.
The path of the item to get.
The type of the item. There can be several items with the same path but with different types.
Will be assigned with the library item or null if no item with the specified path and type can be found.
Rest
...retrievalOptions: LibraryItemRetrievalOption[]Specifies the kinds of metadata that the returned item shall be populated with.
true if an item was found, false otherwise.
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.
The items to copy. Use TryGetItem(path, itemType, item, retrievalOptions), TryGetItem(id, item, retrievalOptions) or Search(searchExpression, retrievalOptions) to retrieve the items.
The folder to copy the items to.
The conflict resolution to use when items with the same name exists in the destination folder.
The items copied to the new folder.
Creates a folder with the specified folderName in the library. The folder is created under the specified parentFolder.
The parent folder.
The name of the folder.
The metadata to associate with the library folder.
An object describing the created library folder.
Deletes the specified item in the library.
The item to delete.
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.
The items to move. Use TryGetItem(path, itemType, item, retrievalOptions), TryGetItem(id, item, retrievalOptions) or Search(searchExpression, retrievalOptions) to retrieve the items.
The folder to move the items to.
The conflict resolution to use when items with the same name exists in the destination folder. Note all items included in itemsToMove are removed after move, also the items that are not moved to the new folder.
The items moved to the new folder.
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.
The library item to update. Use TryGetItem(path, itemType, item, retrievalOptions), TryGetItem(id, item, retrievalOptions) or Search(searchExpression, retrievalOptions) to retrieve the item.
The metadata to set on the library item.
The updated library item.
Sets the title of an existing library item.
The library item to update. Use TryGetItem(path, itemType, item, retrievalOptions), TryGetItem(id, item, retrievalOptions) or Search(searchExpression, retrievalOptions) to retrieve the item.
The new title for the library item.
The updated library item.
Provides access to the Spotfire library. An instance of this class is available as a service on the user level.
Since
2.0