office.customxmlprefixmappings.yml

### YamlMime:TSType
name: Office.CustomXmlPrefixMappings
uid: 'office!Office.CustomXmlPrefixMappings:interface'
package: office!
fullName: Office.CustomXmlPrefixMappings
summary: Represents a collection of CustomXmlPart objects.
remarks: '**Applications**: Word'
isPreview: false
isDeprecated: false
type: interface
methods:
  - name: 'addNamespaceAsync(prefix, ns, options, callback)'
    uid: 'office!Office.CustomXmlPrefixMappings#addNamespaceAsync:member(1)'
    package: office!
    fullName: 'addNamespaceAsync(prefix, ns, options, callback)'
    summary: Asynchronously adds a prefix to namespace mapping to use when querying an item.
    remarks: >-
      **Requirement set**:
      [CustomXmlParts](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts)


      If no namespace is assigned to the requested prefix, the method returns an empty string ("").
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result:
        AsyncResult<void>) => void): void;
      parameters:
        - id: prefix
          description: Specifies the prefix to add to the prefix mapping list. Required.
          type: string
        - id: ns
          description: Specifies the namespace URI to assign to the newly added prefix. Required.
          type: string
        - id: options
          description: 'Provides an option for preserving context data of any type, unchanged, for use in a callback.'
          type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
        - id: callback
          description: >-
            Optional. A function that is invoked when the callback returns, whose only parameter is of type
            [Office.AsyncResult](xref:office!Office.AsyncResult:interface)<!-- -->.
          type: '(result: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
      return:
        type: void
        description: ''
  - name: 'addNamespaceAsync(prefix, ns, callback)'
    uid: 'office!Office.CustomXmlPrefixMappings#addNamespaceAsync:member(2)'
    package: office!
    fullName: 'addNamespaceAsync(prefix, ns, callback)'
    summary: Asynchronously adds a prefix to namespace mapping to use when querying an item.
    remarks: >-
      **Requirement set**:
      [CustomXmlParts](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts)


      If no namespace is assigned to the requested prefix, the method returns an empty string ("").
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;'
      parameters:
        - id: prefix
          description: Specifies the prefix to add to the prefix mapping list. Required.
          type: string
        - id: ns
          description: Specifies the namespace URI to assign to the newly added prefix. Required.
          type: string
        - id: callback
          description: >-
            Optional. A function that is invoked when the callback returns, whose only parameter is of type
            [Office.AsyncResult](xref:office!Office.AsyncResult:interface)<!-- -->.
          type: '(result: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
      return:
        type: void
        description: ''
  - name: 'getNamespaceAsync(prefix, options, callback)'
    uid: 'office!Office.CustomXmlPrefixMappings#getNamespaceAsync:member(1)'
    package: office!
    fullName: 'getNamespaceAsync(prefix, options, callback)'
    summary: Asynchronously gets the namespace mapped to the specified prefix.
    remarks: >-
      **Requirement set**:
      [CustomXmlParts](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts)


      If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix
      except when the prefix is one added or used by the data store internally, in which case it will return an error.
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>)
        => void): void;
      parameters:
        - id: prefix
          description: TSpecifies the prefix to get the namespace for. Required.
          type: string
        - id: options
          description: 'Provides an option for preserving context data of any type, unchanged, for use in a callback.'
          type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
        - id: callback
          description: >-
            Optional. A function that is invoked when the callback returns, whose only parameter is of type
            [Office.AsyncResult](xref:office!Office.AsyncResult:interface)<!-- -->. The `value` property of the result
            is a string that contains the namespace mapped to the specified prefix.
          type: '(result: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
      return:
        type: void
        description: ''
  - name: 'getNamespaceAsync(prefix, callback)'
    uid: 'office!Office.CustomXmlPrefixMappings#getNamespaceAsync:member(2)'
    package: office!
    fullName: 'getNamespaceAsync(prefix, callback)'
    summary: Asynchronously gets the namespace mapped to the specified prefix.
    remarks: >-
      **Requirement set**:
      [CustomXmlParts](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts)


      If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix
      except when the prefix is one added or used by the data store internally, in which case it will return an error.
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;'
      parameters:
        - id: prefix
          description: TSpecifies the prefix to get the namespace for. Required.
          type: string
        - id: callback
          description: >-
            Optional. A function that is invoked when the callback returns, whose only parameter is of type
            [Office.AsyncResult](xref:office!Office.AsyncResult:interface)<!-- -->. The `value` property of the result
            is a string that contains the namespace mapped to the specified prefix.
          type: '(result: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
      return:
        type: void
        description: ''
  - name: 'getPrefixAsync(ns, options, callback)'
    uid: 'office!Office.CustomXmlPrefixMappings#getPrefixAsync:member(1)'
    package: office!
    fullName: 'getPrefixAsync(ns, options, callback)'
    summary: Asynchronously gets the prefix for the specified namespace.
    remarks: >-
      **Requirement set**:
      [CustomXmlParts](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts)


      If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are
      multiple prefixes specified in the namespace manager, the method returns the first prefix that matches the
      supplied namespace.
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) =>
        void): void;
      parameters:
        - id: ns
          description: Specifies the namespace to get the prefix for. Required.
          type: string
        - id: options
          description: 'Provides an option for preserving context data of any type, unchanged, for use in a callback.'
          type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
        - id: callback
          description: >-
            Optional. A function that is invoked when the callback returns, whose only parameter is of type
            [Office.AsyncResult](xref:office!Office.AsyncResult:interface)<!-- -->. The `value` property of the result
            is a string that contains the prefix of the specified namespace.
          type: '(result: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
      return:
        type: void
        description: ''
  - name: 'getPrefixAsync(ns, callback)'
    uid: 'office!Office.CustomXmlPrefixMappings#getPrefixAsync:member(2)'
    package: office!
    fullName: 'getPrefixAsync(ns, callback)'
    summary: Asynchronously gets the prefix for the specified namespace.
    remarks: >-
      **Requirement set**:
      [CustomXmlParts](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts)


      If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are
      multiple prefixes specified in the namespace manager, the method returns the first prefix that matches the
      supplied namespace.
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;'
      parameters:
        - id: ns
          description: Specifies the namespace to get the prefix for. Required.
          type: string
        - id: callback
          description: >-
            Optional. A function that is invoked when the callback returns, whose only parameter is of type
            [Office.AsyncResult](xref:office!Office.AsyncResult:interface)<!-- -->. The `value` property of the result
            is a string that contains the prefix of the specified namespace.
          type: '(result: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
      return:
        type: void
        description: ''