Action
    Preparing search index...

    Class LibraryItemMetadataSettings

    Specifies how the metadata of a library item shall be changed.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Extended capability 'LibraryRead'

    constructor Description TryGetKeywords TryGetProperty

    Extended capability 'LibraryWrite'

    SetKeywords SetProperty

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Extended capability 'LibraryRead'

    • get Description(): string

      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.

      Returns string

      2.0

    • set Description(value: string): void

      Parameters

      • value: string

      Returns void

    • 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.

      Parameters

      Returns boolean

      true if the keywords have previously been set.

      2.0

    • 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.

      Parameters

      • propertyName: string | String

        The name of the custom property to get.

      • property: OutParam<LibraryItemProperty>

        Will be assigned with the previously set custom property or null.

      Returns boolean

      true if the custom property has previously been set.

      2.0

    Extended capability 'LibraryWrite'

    • 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.

      Parameters

      • ...keywords: (string | String)[]

      Returns void

      Calling this methods without any arguments will clear the keywords of a library item.

      2.0

    • 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.

      Parameters

      • propertyName: string | String

        The name of the custom property that should be set.

      • ...values: (string | String)[]

        The values that shall be associated with the custom property.

      Returns void

      Custom properties in the Library must have the same form as DataProperties. That is, they must have a prefix followed by a dot and then a name. The prefix "Spotfire" is reserved and such properties cannot be explicitly set through the API.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Extended capability 'LibraryRead'
    Extended capability 'LibraryWrite'