word.custompropertycollection.yml

### YamlMime:TSType
name: Word.CustomPropertyCollection
uid: 'word!Word.CustomPropertyCollection:class'
package: word!
fullName: Word.CustomPropertyCollection
summary: 'Contains the collection of [Word.CustomProperty](xref:word!Word.CustomProperty:class) objects.'
remarks: >-
  \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


  #### Examples


  ```TypeScript

  // Link to full sample:
  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml


  await Word.run(async (context) => {
      const properties: Word.CustomPropertyCollection = context.document.properties.customProperties;
      properties.load("key,type,value");

      await context.sync();
      for (let i = 0; i < properties.items.length; i++)
          console.log("Property Name:" + properties.items[i].key + "; Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
  });

  ```
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'word!Word.CustomPropertyCollection#context:member'
    package: word!
    fullName: context
    summary: >-
      The request context associated with the object. This connects the add-in's process to the Office host
      application's process.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'context: RequestContext;'
      return:
        type: '<xref uid="word!Word.RequestContext:class" />'
  - name: items
    uid: 'word!Word.CustomPropertyCollection#items:member'
    package: word!
    fullName: items
    summary: Gets the loaded child items in this collection.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly items: Word.CustomProperty[];'
      return:
        type: '<xref uid="word!Word.CustomProperty:class" />[]'
        description: >-


          #### Examples


          ```TypeScript

          // Link to full sample:
          https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml


          await Word.run(async (context) => {
              const properties: Word.CustomPropertyCollection = context.document.properties.customProperties;
              properties.load("key,type,value");

              await context.sync();
              for (let i = 0; i < properties.items.length; i++)
                  console.log("Property Name:" + properties.items[i].key + "; Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
          });

          ```
methods:
  - name: 'add(key, value)'
    uid: 'word!Word.CustomPropertyCollection#add:member(1)'
    package: word!
    fullName: 'add(key, value)'
    summary: Creates a new or sets an existing custom property.
    remarks: >-
      \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml


      await Word.run(async (context) => {
          context.document.properties.customProperties.add("Numeric Property", 1234);

          await context.sync();
          console.log("Property added");
      });


      ...


      await Word.run(async (context) => {
          context.document.properties.customProperties.add("String Property", "Hello World!");

          await context.sync();
          console.log("Property added");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'add(key: string, value: any): Word.CustomProperty;'
      parameters:
        - id: key
          description: 'Required. The custom property''s key, which is case-insensitive.'
          type: string
        - id: value
          description: Required. The custom property's value.
          type: any
      return:
        type: '<xref uid="word!Word.CustomProperty:class" />'
        description: ''
  - name: deleteAll()
    uid: 'word!Word.CustomPropertyCollection#deleteAll:member(1)'
    package: word!
    fullName: deleteAll()
    summary: Deletes all custom properties in this collection.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'deleteAll(): void;'
      return:
        type: void
        description: ''
  - name: getCount()
    uid: 'word!Word.CustomPropertyCollection#getCount:member(1)'
    package: word!
    fullName: getCount()
    summary: Gets the count of custom properties.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getCount(): OfficeExtension.ClientResult<number>;'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;number&gt;'
        description: ''
  - name: getItem(key)
    uid: 'word!Word.CustomPropertyCollection#getItem:member(1)'
    package: word!
    fullName: getItem(key)
    summary: >-
      Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom
      property doesn't exist.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(key: string): Word.CustomProperty;'
      parameters:
        - id: key
          description: The key that identifies the custom property object.
          type: string
      return:
        type: '<xref uid="word!Word.CustomProperty:class" />'
        description: ''
  - name: getItemOrNullObject(key)
    uid: 'word!Word.CustomPropertyCollection#getItemOrNullObject:member(1)'
    package: word!
    fullName: getItemOrNullObject(key)
    summary: >-
      Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then
      this method will return an object with its `isNullObject` property set to `true`<!-- -->. For further information,
      see [*OrNullObject methods and
      properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemOrNullObject(key: string): Word.CustomProperty;'
      parameters:
        - id: key
          description: Required. The key that identifies the custom property object.
          type: string
      return:
        type: '<xref uid="word!Word.CustomProperty:class" />'
        description: ''
  - name: load(options)
    uid: 'word!Word.CustomPropertyCollection#load:member(1)'
    package: word!
    fullName: load(options)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        load(options?: Word.Interfaces.CustomPropertyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions):
        Word.CustomPropertyCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="word!Word.Interfaces.CustomPropertyCollectionLoadOptions:interface" /> & <xref
            uid="word!Word.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="word!Word.CustomPropertyCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'word!Word.CustomPropertyCollection#load:member(2)'
    package: word!
    fullName: load(propertyNames)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNames?: string | string[]): Word.CustomPropertyCollection;'
      parameters:
        - id: propertyNames
          description: A comma-delimited string or an array of strings that specify the properties to load.
          type: 'string | string[]'
      return:
        type: '<xref uid="word!Word.CustomPropertyCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'word!Word.CustomPropertyCollection#load:member(3)'
    package: word!
    fullName: load(propertyNamesAndPaths)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomPropertyCollection;'
      parameters:
        - id: propertyNamesAndPaths
          description: >-
            `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
            `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
          type: '<xref uid="office!OfficeExtension.LoadOption:interface" />'
      return:
        type: '<xref uid="word!Word.CustomPropertyCollection:class" />'
        description: ''
  - name: toJSON()
    uid: 'word!Word.CustomPropertyCollection#toJSON:member(1)'
    package: word!
    fullName: toJSON()
    summary: >-
      Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
      `JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that's
      passed to it.) Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method
      returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`<!-- -->) that contains
      an "items" array with shallow copies of any loaded properties from the collection's items.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Word.Interfaces.CustomPropertyCollectionData;'
      return:
        type: '<xref uid="word!Word.Interfaces.CustomPropertyCollectionData:interface" />'
        description: ''
  - name: track()
    uid: 'word!Word.CustomPropertyCollection#track:member(1)'
    package: word!
    fullName: track()
    summary: >-
      Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand
      for
      [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member)<!--
      -->. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and
      get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the
      object to the tracked object collection when the object was first created. If this object is part of a collection,
      you should also track the parent collection.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'track(): Word.CustomPropertyCollection;'
      return:
        type: '<xref uid="word!Word.CustomPropertyCollection:class" />'
        description: ''
  - name: untrack()
    uid: 'word!Word.CustomPropertyCollection#untrack:member(1)'
    package: word!
    fullName: untrack()
    summary: >-
      Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
      [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member)<!--
      -->. Having many tracked objects slows down the host application, so please remember to free any objects you add,
      once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'untrack(): Word.CustomPropertyCollection;'
      return:
        type: '<xref uid="word!Word.CustomPropertyCollection:class" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'