word.customxmlpartscopedcollection.yml

### YamlMime:TSType
name: Word.CustomXmlPartScopedCollection
uid: 'word!Word.CustomXmlPartScopedCollection:class'
package: word!
fullName: Word.CustomXmlPartScopedCollection
summary: 'Contains the collection of [Word.CustomXmlPart](xref:word!Word.CustomXmlPart:class) objects with a specific namespace.'
remarks: >-
  \[ [API set: WordApi 1.4](/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/50-document/manage-custom-xml-part-ns.yaml


  // Original XML: <Reviewers
  xmlns='http://schemas.contoso.com/review/1.0'><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>


  // Gets the custom XML parts with the specified namespace URI.

  await Word.run(async (context) => {
    const namespaceUri = "http://schemas.contoso.com/review/1.0";
    console.log(`Specified namespace URI: ${namespaceUri}`);
    const scopedCustomXmlParts : Word.CustomXmlPartScopedCollection =
      context.document.customXmlParts.getByNamespace(namespaceUri);
    scopedCustomXmlParts.load("items");
    await context.sync();

    console.log(`Number of custom XML parts found with this namespace: ${!scopedCustomXmlParts.items ? 0 : scopedCustomXmlParts.items.length}`);
  });

  ```
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'word!Word.CustomXmlPartScopedCollection#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.CustomXmlPartScopedCollection#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.CustomXmlPart[];'
      return:
        type: '<xref uid="word!Word.CustomXmlPart:class" />[]'
methods:
  - name: getCount()
    uid: 'word!Word.CustomXmlPartScopedCollection#getCount:member(1)'
    package: word!
    fullName: getCount()
    summary: Gets the number of items in the collection.
    remarks: '\[ [API set: WordApi 1.4](/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(id)
    uid: 'word!Word.CustomXmlPartScopedCollection#getItem:member(1)'
    package: word!
    fullName: getItem(id)
    summary: Gets a custom XML part based on its ID.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(id: string): Word.CustomXmlPart;'
      parameters:
        - id: id
          description: ID of the custom XML part to be retrieved.
          type: string
      return:
        type: '<xref uid="word!Word.CustomXmlPart:class" />'
        description: ''
  - name: getItemOrNullObject(id)
    uid: 'word!Word.CustomXmlPartScopedCollection#getItemOrNullObject:member(1)'
    package: word!
    fullName: getItemOrNullObject(id)
    summary: >-
      Gets a custom XML part based on its ID. If the CustomXmlPart doesn't exist in the collection, 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.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemOrNullObject(id: string): Word.CustomXmlPart;'
      parameters:
        - id: id
          description: Required. ID of the object to be retrieved.
          type: string
      return:
        type: '<xref uid="word!Word.CustomXmlPart:class" />'
        description: ''
  - name: getOnlyItem()
    uid: 'word!Word.CustomXmlPartScopedCollection#getOnlyItem:member(1)'
    package: word!
    fullName: getOnlyItem()
    summary: 'If the collection contains exactly one item, this method returns it. Otherwise, this method produces an error.'
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getOnlyItem(): Word.CustomXmlPart;'
      return:
        type: '<xref uid="word!Word.CustomXmlPart:class" />'
        description: ''
  - name: getOnlyItemOrNullObject()
    uid: 'word!Word.CustomXmlPartScopedCollection#getOnlyItemOrNullObject:member(1)'
    package: word!
    fullName: getOnlyItemOrNullObject()
    summary: >-
      If the collection contains exactly one item, this method returns it. Otherwise, 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.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getOnlyItemOrNullObject(): Word.CustomXmlPart;'
      return:
        type: '<xref uid="word!Word.CustomXmlPart:class" />'
        description: ''
  - name: load(options)
    uid: 'word!Word.CustomXmlPartScopedCollection#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.CustomXmlPartScopedCollectionLoadOptions &
        Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPartScopedCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="word!Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions:interface" /> & <xref
            uid="word!Word.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="word!Word.CustomXmlPartScopedCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'word!Word.CustomXmlPartScopedCollection#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.CustomXmlPartScopedCollection;'
      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.CustomXmlPartScopedCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'word!Word.CustomXmlPartScopedCollection#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.CustomXmlPartScopedCollection;'
      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.CustomXmlPartScopedCollection:class" />'
        description: ''
  - name: toJSON()
    uid: 'word!Word.CustomXmlPartScopedCollection#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 is
      passed to it.) Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON`
      method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`<!-- -->)
      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.CustomXmlPartScopedCollectionData;'
      return:
        type: '<xref uid="word!Word.Interfaces.CustomXmlPartScopedCollectionData:interface" />'
        description: ''
  - name: track()
    uid: 'word!Word.CustomXmlPartScopedCollection#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.CustomXmlPartScopedCollection;'
      return:
        type: '<xref uid="word!Word.CustomXmlPartScopedCollection:class" />'
        description: ''
  - name: untrack()
    uid: 'word!Word.CustomXmlPartScopedCollection#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.CustomXmlPartScopedCollection;'
      return:
        type: '<xref uid="word!Word.CustomXmlPartScopedCollection:class" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'