excel.conditionalrangebordercollection.yml

### YamlMime:TSType
name: Excel.ConditionalRangeBorderCollection
uid: 'excel!Excel.ConditionalRangeBorderCollection:class'
package: excel!
fullName: Excel.ConditionalRangeBorderCollection
summary: Represents the border objects that make up range border.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: bottom
    uid: 'excel!Excel.ConditionalRangeBorderCollection#bottom:member'
    package: excel!
    fullName: bottom
    summary: Gets the bottom border.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly bottom: Excel.ConditionalRangeBorder;'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
  - name: context
    uid: 'excel!Excel.ConditionalRangeBorderCollection#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: count
    uid: 'excel!Excel.ConditionalRangeBorderCollection#count:member'
    package: excel!
    fullName: count
    summary: Number of border objects in the collection.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly count: number;'
      return:
        type: number
  - name: items
    uid: 'excel!Excel.ConditionalRangeBorderCollection#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.ConditionalRangeBorder[];'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />[]'
  - name: left
    uid: 'excel!Excel.ConditionalRangeBorderCollection#left:member'
    package: excel!
    fullName: left
    summary: Gets the left border.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly left: Excel.ConditionalRangeBorder;'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
  - name: right
    uid: 'excel!Excel.ConditionalRangeBorderCollection#right:member'
    package: excel!
    fullName: right
    summary: Gets the right border.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly right: Excel.ConditionalRangeBorder;'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
  - name: top
    uid: 'excel!Excel.ConditionalRangeBorderCollection#top:member'
    package: excel!
    fullName: top
    summary: Gets the top border.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly top: Excel.ConditionalRangeBorder;'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
methods:
  - name: getItem(index)
    uid: 'excel!Excel.ConditionalRangeBorderCollection#getItem:member(1)'
    package: excel!
    fullName: getItem(index)
    summary: Gets a border object using its name.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;'
      parameters:
        - id: index
          description: Index value of the border object to be retrieved. See `Excel.ConditionalRangeBorderIndex` for details.
          type: '<xref uid="excel!Excel.ConditionalRangeBorderIndex:enum" />'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
        description: ''
  - name: getItem(indexString)
    uid: 'excel!Excel.ConditionalRangeBorderCollection#getItem:member(2)'
    package: excel!
    fullName: getItem(indexString)
    summary: Gets a border object using its name.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;'
      parameters:
        - id: indexString
          description: Index value of the border object to be retrieved. See `Excel.ConditionalRangeBorderIndex` for details.
          type: '"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"'
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
        description: ''
  - name: getItemAt(index)
    uid: 'excel!Excel.ConditionalRangeBorderCollection#getItemAt:member(1)'
    package: excel!
    fullName: getItemAt(index)
    summary: Gets a border object using its index.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemAt(index: number): Excel.ConditionalRangeBorder;'
      parameters:
        - id: index
          description: Index value of the object to be retrieved. Zero-indexed.
          type: number
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorder:class" />'
        description: ''
  - name: load(options)
    uid: 'excel!Excel.ConditionalRangeBorderCollection#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.ConditionalRangeBorderCollectionLoadOptions &
        Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions:interface" /> & <xref
            uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="excel!Excel.ConditionalRangeBorderCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.ConditionalRangeBorderCollection#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.ConditionalRangeBorderCollection;'
      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.ConditionalRangeBorderCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.ConditionalRangeBorderCollection#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.ConditionalRangeBorderCollection;'
      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.ConditionalRangeBorderCollection:class" />'
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.ConditionalRangeBorderCollection#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.ConditionalRangeBorderCollection` object is an API object, the `toJSON`
      method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeBorderCollectionData`<!--
      -->) 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.ConditionalRangeBorderCollectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ConditionalRangeBorderCollectionData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'