LibraryItemMetadataSettings Class

Spotfire 14.2 API Reference
Specifies how the metadata of a library item shall be changed.
Inheritance Hierarchy

SystemObject
  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

  NameDescription
Public methodLibraryItemMetadataSettings
Creates a default metadata specification instance.
Top
Properties

  NameDescription
Public propertyDescription
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.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetKeywords
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.
Public methodSetProperty
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetKeywords
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.
Public methodTryGetProperty
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.
Top
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

Reference