excel.interfaces.commentloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.CommentLoadOptions
uid: 'excel!Excel.Interfaces.CommentLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.CommentLoadOptions
summary: Represents a comment in the workbook.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: authorEmail
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#authorEmail:member'
    package: excel!
    fullName: authorEmail
    summary: Gets the email of the comment's author.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'authorEmail?: boolean;'
      return:
        type: boolean
  - name: authorName
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#authorName:member'
    package: excel!
    fullName: authorName
    summary: Gets the name of the comment's author.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'authorName?: boolean;'
      return:
        type: boolean
  - name: content
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#content:member'
    package: excel!
    fullName: content
    summary: The comment's content. The string is plain text.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'content?: boolean;'
      return:
        type: boolean
  - name: contentType
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#contentType:member'
    package: excel!
    fullName: contentType
    summary: Gets the content type of the comment.
    remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'contentType?: boolean;'
      return:
        type: boolean
  - name: creationDate
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#creationDate:member'
    package: excel!
    fullName: creationDate
    summary: >-
      Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment
      does not have a creation date.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'creationDate?: boolean;'
      return:
        type: boolean
  - name: id
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#id:member'
    package: excel!
    fullName: id
    summary: Specifies the comment identifier.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: boolean;'
      return:
        type: boolean
  - name: mentions
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#mentions:member'
    package: excel!
    fullName: mentions
    summary: 'Gets the entities (e.g., people) that are mentioned in comments.'
    remarks: '\[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'mentions?: boolean;'
      return:
        type: boolean
  - name: resolved
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#resolved:member'
    package: excel!
    fullName: resolved
    summary: The comment thread status. A value of `true` means that the comment thread is resolved.
    remarks: '\[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'resolved?: boolean;'
      return:
        type: boolean
  - name: richContent
    uid: 'excel!Excel.Interfaces.CommentLoadOptions#richContent:member'
    package: excel!
    fullName: richContent
    summary: >-
      Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users.
      Your add-in should only use this to parse rich comment content.
    remarks: '\[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'richContent?: boolean;'
      return:
        type: boolean