excel.documentproperties.yml

### YamlMime:TSType
name: Excel.DocumentProperties
uid: 'excel!Excel.DocumentProperties:class'
package: excel!
fullName: Excel.DocumentProperties
summary: Represents workbook properties.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: author
    uid: 'excel!Excel.DocumentProperties#author:member'
    package: excel!
    fullName: author
    summary: The author of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'author: string;'
      return:
        type: string
  - name: category
    uid: 'excel!Excel.DocumentProperties#category:member'
    package: excel!
    fullName: category
    summary: The category of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'category: string;'
      return:
        type: string
  - name: comments
    uid: 'excel!Excel.DocumentProperties#comments:member'
    package: excel!
    fullName: comments
    summary: The comments of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'comments: string;'
      return:
        type: string
  - name: company
    uid: 'excel!Excel.DocumentProperties#company:member'
    package: excel!
    fullName: company
    summary: The company of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'company: string;'
      return:
        type: string
  - name: context
    uid: 'excel!Excel.DocumentProperties#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: creationDate
    uid: 'excel!Excel.DocumentProperties#creationDate:member'
    package: excel!
    fullName: creationDate
    summary: Gets the creation date of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly creationDate: Date;'
      return:
        type: Date
  - name: custom
    uid: 'excel!Excel.DocumentProperties#custom:member'
    package: excel!
    fullName: custom
    summary: Gets the collection of custom properties of the workbook.
    remarks: >-
      \[ [API set: ExcelApi 1.7](/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/26-document/custom-properties.yaml


      await Excel.run(async (context) => {
        // Load the keys and values of all custom properties.
        const customDocProperties = context.workbook.properties.custom;
        customDocProperties.load(["key", "value"]);
        await context.sync();

        // Log each custom property to the console.
        // Note that your document may have more properties than those you have set using this snippet.
        customDocProperties.items.forEach((property) => {
          console.log(`${property.key}:${property.value}`);
        });
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly custom: Excel.CustomPropertyCollection;'
      return:
        type: '<xref uid="excel!Excel.CustomPropertyCollection:class" />'
  - name: keywords
    uid: 'excel!Excel.DocumentProperties#keywords:member'
    package: excel!
    fullName: keywords
    summary: The keywords of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'keywords: string;'
      return:
        type: string
  - name: lastAuthor
    uid: 'excel!Excel.DocumentProperties#lastAuthor:member'
    package: excel!
    fullName: lastAuthor
    summary: Gets the last author of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly lastAuthor: string;'
      return:
        type: string
  - name: manager
    uid: 'excel!Excel.DocumentProperties#manager:member'
    package: excel!
    fullName: manager
    summary: The manager of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'manager: string;'
      return:
        type: string
  - name: revisionNumber
    uid: 'excel!Excel.DocumentProperties#revisionNumber:member'
    package: excel!
    fullName: revisionNumber
    summary: Gets the revision number of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'revisionNumber: number;'
      return:
        type: number
  - name: subject
    uid: 'excel!Excel.DocumentProperties#subject:member'
    package: excel!
    fullName: subject
    summary: The subject of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'subject: string;'
      return:
        type: string
  - name: title
    uid: 'excel!Excel.DocumentProperties#title:member'
    package: excel!
    fullName: title
    summary: The title of the workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'title: string;'
      return:
        type: string
methods:
  - name: load(options)
    uid: 'excel!Excel.DocumentProperties#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.DocumentPropertiesLoadOptions): Excel.DocumentProperties;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.DocumentPropertiesLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.DocumentProperties:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.DocumentProperties#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.DocumentProperties;'
      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.DocumentProperties:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.DocumentProperties#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.DocumentProperties;
      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.DocumentProperties:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.DocumentProperties#set:member(1)'
    package: excel!
    fullName: 'set(properties, options)'
    summary: >-
      Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
      properties, or another API object of the same type.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;'
      parameters:
        - id: properties
          description: >-
            A JavaScript object with properties that are structured isomorphically to the properties of the object on
            which the method is called.
          type: '<xref uid="excel!Excel.Interfaces.DocumentPropertiesUpdateData:interface" />'
        - id: options
          description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
          type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
      return:
        type: void
        description: ''
  - name: set(properties)
    uid: 'excel!Excel.DocumentProperties#set:member(2)'
    package: excel!
    fullName: set(properties)
    summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Excel.DocumentProperties): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.DocumentProperties:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.DocumentProperties#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.DocumentProperties object is an API object, the `toJSON` method returns
      a plain JavaScript object (typed as `Excel.Interfaces.DocumentPropertiesData`<!-- -->) that contains shallow
      copies of any loaded child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.DocumentPropertiesData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.DocumentPropertiesData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'