excel.interfaces.worksheetcustompropertycollectionloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions
uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions
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: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions#$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: key
    uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions#key:member'
    package: excel!
    fullName: key
    summary: >-
      For EACH ITEM in the collection: Gets the key of the custom property. Custom property keys are case-insensitive.
      The key is limited to 255 characters (larger values will cause an `InvalidArgument` error to be thrown.)
    remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'key?: boolean;'
      return:
        type: boolean
  - name: value
    uid: 'excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions#value:member'
    package: excel!
    fullName: value
    summary: 'For EACH ITEM in the collection: Gets or sets the value of the custom property.'
    remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'value?: boolean;'
      return:
        type: boolean