excel.customxmlpart.yml

### YamlMime:TSType
name: Excel.CustomXmlPart
uid: 'excel!Excel.CustomXmlPart:class'
package: excel!
fullName: Excel.CustomXmlPart
summary: Represents a custom XML part object in a workbook.
remarks: '\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.CustomXmlPart#context:member'
    package: excel!
    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="excel!Excel.RequestContext:class" />'
  - name: id
    uid: 'excel!Excel.CustomXmlPart#id:member'
    package: excel!
    fullName: id
    summary: The custom XML part's ID.
    remarks: >-
      \[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml


      await Excel.run(async (context) => {
          // You must have the xmlns attribute to populate the 
          // CustomXml.namespaceUri property.
          const originalXml = "<Reviewers xmlns='http://schemas.contoso.com/review/1.0'><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>";
          const customXmlPart = context.workbook.customXmlParts.add(originalXml);
          customXmlPart.load("id");
          const xmlBlob = customXmlPart.getXml();

          await context.sync();

          const readableXml = addLineBreaksToXML(xmlBlob.value);
          $("#display-xml").text(readableXml);

          // Store the XML part's ID in a setting.
          const settings = context.workbook.settings;
          settings.add("ContosoReviewXmlPartId", customXmlPart.id);

          await context.sync();
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly id: string;'
      return:
        type: string
  - name: namespaceUri
    uid: 'excel!Excel.CustomXmlPart#namespaceUri:member'
    package: excel!
    fullName: namespaceUri
    summary: The custom XML part's namespace URI.
    remarks: '\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly namespaceUri: string;'
      return:
        type: string
methods:
  - name: delete()
    uid: 'excel!Excel.CustomXmlPart#delete:member(1)'
    package: excel!
    fullName: delete()
    summary: Deletes the custom XML part.
    remarks: >-
      \[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml


      await Excel.run(async (context) => {
          const settings = context.workbook.settings;
          const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value");
          await context.sync();

          if (xmlPartIDSetting.value) {   
              let customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value);
              const xmlBlob = customXmlPart.getXml();
              customXmlPart.delete();
              customXmlPart = context.workbook.customXmlParts.getItemOrNullObject(xmlPartIDSetting.value);

              await context.sync();

              if (customXmlPart.isNullObject) {
                  $("#display-xml").text(`The XML part with the id ${xmlPartIDSetting.value} has been deleted.`);

                  // Delete the unneeded setting too.
                  xmlPartIDSetting.delete();            
              } else {
                  const readableXml = addLineBreaksToXML(xmlBlob.value);
                  const strangeMessage = `This is strange. The XML part with the id ${xmlPartIDSetting.value} has not been deleted:\n${readableXml}`
                  $("#display-xml").text(strangeMessage);
              }

              await context.sync();
          }
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'delete(): void;'
      return:
        type: void
        description: ''
  - name: getXml()
    uid: 'excel!Excel.CustomXmlPart#getXml:member(1)'
    package: excel!
    fullName: getXml()
    summary: Gets the custom XML part's full XML content.
    remarks: >-
      \[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml


      await Excel.run(async (context) => {
          // You must have the xmlns attribute to populate the 
          // CustomXml.namespaceUri property.
          const originalXml = "<Reviewers xmlns='http://schemas.contoso.com/review/1.0'><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>";
          const customXmlPart = context.workbook.customXmlParts.add(originalXml);
          customXmlPart.load("id");
          const xmlBlob = customXmlPart.getXml();

          await context.sync();

          const readableXml = addLineBreaksToXML(xmlBlob.value);
          $("#display-xml").text(readableXml);

          // Store the XML part's ID in a setting.
          const settings = context.workbook.settings;
          settings.add("ContosoReviewXmlPartId", customXmlPart.id);

          await context.sync();
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getXml(): OfficeExtension.ClientResult<string>;'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string&gt;'
        description: ''
  - name: load(options)
    uid: 'excel!Excel.CustomXmlPart#load:member(1)'
    package: excel!
    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?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.CustomXmlPartLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.CustomXmlPart:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.CustomXmlPart#load:member(2)'
    package: excel!
    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[]): Excel.CustomXmlPart;'
      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="excel!Excel.CustomXmlPart:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.CustomXmlPart#load:member(3)'
    package: excel!
    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?: {
                    select?: string;
                    expand?: string;
                }): Excel.CustomXmlPart;
      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: |-
            {
                        select?: string;
                        expand?: string;
                    }
      return:
        type: '<xref uid="excel!Excel.CustomXmlPart:class" />'
        description: ''
  - name: setXml(xml)
    uid: 'excel!Excel.CustomXmlPart#setXml:member(1)'
    package: excel!
    fullName: setXml(xml)
    summary: Sets the custom XML part's full XML content.
    remarks: >-
      \[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml


      await Excel.run(async (context) => {
          const settings = context.workbook.settings;
          const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value");
          await context.sync();

          if (xmlPartIDSetting.value) {   
              const customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value);

              // The setXml method does a whole-for-whole replacement 
              // of the entire XML.
              customXmlPart.setXml("<Reviewers xmlns='http://schemas.contoso.com/review/1.0'><Reviewer>John</Reviewer><Reviewer>Hitomi</Reviewer></Reviewers>");
              const xmlBlob = customXmlPart.getXml();
              await context.sync();

              const readableXml = addLineBreaksToXML(xmlBlob.value);
              $("#display-xml").text(readableXml);
              await context.sync();
          }
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setXml(xml: string): void;'
      parameters:
        - id: xml
          description: XML content for the part.
          type: string
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.CustomXmlPart#toJSON:member(1)'
    package: excel!
    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 Excel.CustomXmlPart object is an API object, the `toJSON` method returns a
      plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartData`<!-- -->) that contains shallow copies of
      any loaded child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.CustomXmlPartData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CustomXmlPartData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'