onenote.inkanalysisparagraphcollection.yml

### YamlMime:TSType
name: OneNote.InkAnalysisParagraphCollection
uid: 'onenote!OneNote.InkAnalysisParagraphCollection:class'
package: onenote!
fullName: OneNote.InkAnalysisParagraphCollection
summary: Represents a collection of InkAnalysisParagraph objects.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#context:member'
    package: onenote!
    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="onenote!OneNote.RequestContext:class" />'
  - name: count
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#count:member'
    package: onenote!
    fullName: count
    summary: Returns the number of InkAnalysisParagraphs in the page. Read-only.
    remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly count: number;'
      return:
        type: number
  - name: items
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#items:member'
    package: onenote!
    fullName: items
    summary: Gets the loaded child items in this collection.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly items: OneNote.InkAnalysisParagraph[];'
      return:
        type: '<xref uid="onenote!OneNote.InkAnalysisParagraph:class" />[]'
methods:
  - name: getItem(index)
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#getItem:member(1)'
    package: onenote!
    fullName: getItem(index)
    summary: Gets a InkAnalysisParagraph object by ID or by its index in the collection. Read-only.
    remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(index: number | string): OneNote.InkAnalysisParagraph;'
      parameters:
        - id: index
          description: >-
            The ID of the InkAnalysisParagraph object, or the index location of the InkAnalysisParagraph object in the
            collection.
          type: number | string
      return:
        type: '<xref uid="onenote!OneNote.InkAnalysisParagraph:class" />'
        description: ''
  - name: getItemAt(index)
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#getItemAt:member(1)'
    package: onenote!
    fullName: getItemAt(index)
    summary: Gets a InkAnalysisParagraph on its position in the collection.
    remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemAt(index: number): OneNote.InkAnalysisParagraph;'
      parameters:
        - id: index
          description: Index value of the object to be retrieved. Zero-indexed.
          type: number
      return:
        type: '<xref uid="onenote!OneNote.InkAnalysisParagraph:class" />'
        description: ''
  - name: load(options)
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#load:member(1)'
    package: onenote!
    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?: OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions &
        OneNote.Interfaces.CollectionLoadOptions): OneNote.InkAnalysisParagraphCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="onenote!OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions:interface" /> & <xref
            uid="onenote!OneNote.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="onenote!OneNote.InkAnalysisParagraphCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#load:member(2)'
    package: onenote!
    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[]): OneNote.InkAnalysisParagraphCollection;'
      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="onenote!OneNote.InkAnalysisParagraphCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#load:member(3)'
    package: onenote!
    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): OneNote.InkAnalysisParagraphCollection;'
      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="onenote!OneNote.InkAnalysisParagraphCollection:class" />'
        description: ''
  - name: toJSON()
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#toJSON:member(1)'
    package: onenote!
    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 `OneNote.InkAnalysisParagraphCollection` object is an API object, the `toJSON`
      method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphCollectionData`<!--
      -->) 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(): OneNote.Interfaces.InkAnalysisParagraphCollectionData;'
      return:
        type: '<xref uid="onenote!OneNote.Interfaces.InkAnalysisParagraphCollectionData:interface" />'
        description: ''
  - name: track()
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#track:member(1)'
    package: onenote!
    fullName: track()
    summary: >-
      Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand
      for `context.trackedObjects.add(thisObject)`<!-- -->. If you are using this object across `.sync` calls and
      outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property
      or invoking a method on the object, you needed to have added the object to the tracked object collection when the
      object was first created.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'track(): OneNote.InkAnalysisParagraphCollection;'
      return:
        type: '<xref uid="onenote!OneNote.InkAnalysisParagraphCollection:class" />'
        description: ''
  - name: untrack()
    uid: 'onenote!OneNote.InkAnalysisParagraphCollection#untrack:member(1)'
    package: onenote!
    fullName: untrack()
    summary: >-
      Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
      `context.trackedObjects.remove(thisObject)`<!-- -->. Having many tracked objects slows down the host application,
      so please remember to free any objects you add, once you're done using them. You will need to call
      `context.sync()` before the memory release takes effect.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'untrack(): OneNote.InkAnalysisParagraphCollection;'
      return:
        type: '<xref uid="onenote!OneNote.InkAnalysisParagraphCollection:class" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'