Class LibraryItemMetadataSettings

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

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'LibraryRead'

constructor Description TryGetKeywords TryGetProperty

Extended capability 'LibraryWrite'

SetKeywords SetProperty

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

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

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

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

constructor

Description

  • 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

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

TryGetKeywords

  • TryGetKeywords(keywordsProperty): boolean

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

    Since

    2.0

TryGetProperty

  • TryGetProperty(propertyName, property): boolean

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

    Since

    2.0

Extended capability 'LibraryWrite'

SetKeywords

  • SetKeywords(...keywords): void

  • 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

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

    Returns void

    Since

    2.0

SetProperty

  • SetProperty(propertyName, ...values): void

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

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

      The values that shall be associated with the custom property.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Extended capability 'LibraryRead'
Extended capability 'LibraryWrite'