Specifies how the metadata of a library item shall be changed.
Inheritance Hierarchy
Spotfire.Dxp.Framework.LibraryLibraryItemMetadataSettings
Namespace: Spotfire.Dxp.Framework.Library
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax
C#
public sealed class LibraryItemMetadataSettings
The LibraryItemMetadataSettings type exposes the following members.
Constructors
Name | Description | |
---|---|---|
LibraryItemMetadataSettings |
Creates a default metadata specification instance.
|
Properties
Name | Description | |
---|---|---|
Description |
Gets or sets the description to associate with a library entry. If null, the description is not changed.
If this property is set, it overrides any description specified by document properties when the document
is saved to the library.
|
Methods
Name | Description | |
---|---|---|
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.) | |
SetKeywords |
Sets the keywords to associate with a library entry.
By default the keywords are not changed.
The keywords set with this method will override any keywords specified by document properties when the document
is saved to the library.
| |
SetProperty |
Adds a custom property that shall be set on the library item. The property value will be updated
if it is already set on the library item.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TryGetKeywords |
Tries to get the keywords previously set by the SetKeywords method. Returns true and
assigns the keywordsProperty parameter if the keywords have previously
been set.
| |
TryGetProperty |
Tries to get the custom property previously set by the SetProperty method. Returns true and
assigns the property parameter if the keywords have previously
been set.
|
Version Information
Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also