excel.worksheetcustompropertycollection.yml

### YamlMime:TSType
name: Excel.WorksheetCustomPropertyCollection
uid: 'excel!Excel.WorksheetCustomPropertyCollection:class'
package: excel!
fullName: Excel.WorksheetCustomPropertyCollection
summary: Contains the collection of worksheet-level custom property.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#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.WorksheetCustomPropertyCollection#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.WorksheetCustomProperty[];'
      return:
        type: '<xref uid="excel!Excel.WorksheetCustomProperty:class" />[]'
methods:
  - name: 'add(key, value)'
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#add:member(1)'
    package: excel!
    fullName: 'add(key, value)'
    summary: >-
      Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that
      key.
    remarks: >-
      \[ [API set: ExcelApi 1.12](/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) => {
        // Get the key/value pair from the task pane.
        const userKey = $("#key").text();
        const userValue = $("#value").text();

        // Add the custom property.
        const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
        customWorksheetProperties.add(userKey, userValue);

        await context.sync();

        console.log(`Successfully set custom worksheet property ${userKey}:${userValue}.`);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'add(key: string, value: string): Excel.WorksheetCustomProperty;'
      parameters:
        - id: key
          description: >-
            The key that identifies the custom property object. It is case-insensitive.The key is limited to 255
            characters (larger values will cause an `InvalidArgument` error to be thrown.)
          type: string
        - id: value
          description: The value of this custom property.
          type: string
      return:
        type: '<xref uid="excel!Excel.WorksheetCustomProperty:class" />'
        description: ''
  - name: getCount()
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#getCount:member(1)'
    package: excel!
    fullName: getCount()
    summary: Gets the number of custom properties on this worksheet.
    remarks: '\[ [API set: ExcelApi 1.12](/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(key)
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#getItem:member(1)'
    package: excel!
    fullName: getItem(key)
    summary: >-
      Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does
      not exist.
    remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(key: string): Excel.WorksheetCustomProperty;'
      parameters:
        - id: key
          description: The key that identifies the custom property object. It is case-insensitive.
          type: string
      return:
        type: '<xref uid="excel!Excel.WorksheetCustomProperty:class" />'
        description: ''
  - name: getItemOrNullObject(key)
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#getItemOrNullObject:member(1)'
    package: excel!
    fullName: getItemOrNullObject(key)
    summary: >-
      Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't 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.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemOrNullObject(key: string): Excel.WorksheetCustomProperty;'
      parameters:
        - id: key
          description: The key that identifies the custom property object. It is case-insensitive.
          type: string
      return:
        type: '<xref uid="excel!Excel.WorksheetCustomProperty:class" />'
        description: ''
  - name: load(options)
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#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.WorksheetCustomPropertyCollectionLoadOptions &
        Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions:interface" /> & <xref
            uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="excel!Excel.WorksheetCustomPropertyCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#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.WorksheetCustomPropertyCollection;'
      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.WorksheetCustomPropertyCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#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.WorksheetCustomPropertyCollection;'
      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.WorksheetCustomPropertyCollection:class" />'
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.WorksheetCustomPropertyCollection#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.WorksheetCustomPropertyCollection` object is an API object, the
      `toJSON` method returns a plain JavaScript object (typed as
      `Excel.Interfaces.WorksheetCustomPropertyCollectionData`<!-- -->) 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.WorksheetCustomPropertyCollectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.WorksheetCustomPropertyCollectionData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'