excel.commentreplycollection.yml

### YamlMime:TSType
name: Excel.CommentReplyCollection
uid: 'excel!Excel.CommentReplyCollection:class'
package: excel!
fullName: Excel.CommentReplyCollection
summary: Represents a collection of comment reply objects that are part of the comment.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.CommentReplyCollection#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: items
    uid: 'excel!Excel.CommentReplyCollection#items:member'
    package: excel!
    fullName: items
    summary: Gets the loaded child items in this collection.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly items: Excel.CommentReply[];'
      return:
        type: '<xref uid="excel!Excel.CommentReply:class" />[]'
methods:
  - name: 'add(content, contentType)'
    uid: 'excel!Excel.CommentReplyCollection#add:member(1)'
    package: excel!
    fullName: 'add(content, contentType)'
    summary: Creates a comment reply for a comment.
    remarks: >-
      \[ [API set: ExcelApi 1.10](/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/12-comment/comment-replies.yaml


      await Excel.run(async (context) => {
          // Adds a reply to the first comment in this worksheet.
          const sheet = context.workbook.worksheets.getItem("Comments");
          const comment = sheet.comments.getItemAt(0);
          comment.replies.add("Add content to this worksheet.");
          await context.sync();
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;'
      parameters:
        - id: content
          description: >-
            The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with
            mentions). \[Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object\]
          type: '<xref uid="excel!Excel.CommentRichContent:interface" /> | string'
        - id: contentType
          description: >-
            Optional. The type of content contained within the comment. The default value is enum
            `ContentType.Plain`<!-- -->. \[Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum
            ContentType.Mention\]
          type: '<xref uid="excel!Excel.ContentType:enum" />'
      return:
        type: '<xref uid="excel!Excel.CommentReply:class" />'
        description: ''
  - name: 'add(content, contentTypeString)'
    uid: 'excel!Excel.CommentReplyCollection#add:member(2)'
    package: excel!
    fullName: 'add(content, contentTypeString)'
    summary: Creates a comment reply for a comment.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;'
      parameters:
        - id: content
          description: >-
            The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with
            mentions). \[Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object\]
          type: '<xref uid="excel!Excel.CommentRichContent:interface" /> | string'
        - id: contentTypeString
          description: >-
            Optional. The type of content contained within the comment. The default value is enum
            `ContentType.Plain`<!-- -->. \[Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum
            ContentType.Mention\]
          type: '"Plain" | "Mention"'
      return:
        type: '<xref uid="excel!Excel.CommentReply:class" />'
        description: ''
  - name: getCount()
    uid: 'excel!Excel.CommentReplyCollection#getCount:member(1)'
    package: excel!
    fullName: getCount()
    summary: Gets the number of comment replies in the collection.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-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(commentReplyId)
    uid: 'excel!Excel.CommentReplyCollection#getItem:member(1)'
    package: excel!
    fullName: getItem(commentReplyId)
    summary: Returns a comment reply identified by its ID.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(commentReplyId: string): Excel.CommentReply;'
      parameters:
        - id: commentReplyId
          description: The identifier for the comment reply.
          type: string
      return:
        type: '<xref uid="excel!Excel.CommentReply:class" />'
        description: ''
  - name: getItemAt(index)
    uid: 'excel!Excel.CommentReplyCollection#getItemAt:member(1)'
    package: excel!
    fullName: getItemAt(index)
    summary: Gets a comment reply based on its position in the collection.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemAt(index: number): Excel.CommentReply;'
      parameters:
        - id: index
          description: The index value of the comment reply to be retrieved. The collection uses zero-based indexing.
          type: number
      return:
        type: '<xref uid="excel!Excel.CommentReply:class" />'
        description: ''
  - name: getItemOrNullObject(commentReplyId)
    uid: 'excel!Excel.CommentReplyCollection#getItemOrNullObject:member(1)'
    package: excel!
    fullName: getItemOrNullObject(commentReplyId)
    summary: >-
      Returns a comment reply identified by its ID. If the comment reply object does not exist, then this method returns
      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: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemOrNullObject(commentReplyId: string): Excel.CommentReply;'
      parameters:
        - id: commentReplyId
          description: The identifier for the comment reply.
          type: string
      return:
        type: '<xref uid="excel!Excel.CommentReply:class" />'
        description: ''
  - name: load(options)
    uid: 'excel!Excel.CommentReplyCollection#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.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions):
        Excel.CommentReplyCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="excel!Excel.Interfaces.CommentReplyCollectionLoadOptions:interface" /> & <xref
            uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="excel!Excel.CommentReplyCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.CommentReplyCollection#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.CommentReplyCollection;'
      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.CommentReplyCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.CommentReplyCollection#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?: OfficeExtension.LoadOption): Excel.CommentReplyCollection;'
      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="excel!Excel.CommentReplyCollection:class" />'
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.CommentReplyCollection#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.CommentReplyCollection` object is an API object, the `toJSON` method
      returns a plain JavaScript object (typed as `Excel.Interfaces.CommentReplyCollectionData`<!-- -->) 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(): Excel.Interfaces.CommentReplyCollectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CommentReplyCollectionData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'