excel.interfaces.rangeformatdata.yml

### YamlMime:TSType
name: Excel.Interfaces.RangeFormatData
uid: 'excel!Excel.Interfaces.RangeFormatData:interface'
package: excel!
fullName: Excel.Interfaces.RangeFormatData
summary: An interface describing the data returned by calling `rangeFormat.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: borders
    uid: 'excel!Excel.Interfaces.RangeFormatData#borders:member'
    package: excel!
    fullName: borders
    summary: Collection of border objects that apply to the overall range.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'borders?: Excel.Interfaces.RangeBorderData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeBorderData:interface" />[]'
  - name: columnWidth
    uid: 'excel!Excel.Interfaces.RangeFormatData#columnWidth:member'
    package: excel!
    fullName: columnWidth
    summary: >-
      Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be
      returned.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'columnWidth?: number;'
      return:
        type: number
  - name: fill
    uid: 'excel!Excel.Interfaces.RangeFormatData#fill:member'
    package: excel!
    fullName: fill
    summary: Returns the fill object defined on the overall range.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'fill?: Excel.Interfaces.RangeFillData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeFillData:interface" />'
  - name: font
    uid: 'excel!Excel.Interfaces.RangeFormatData#font:member'
    package: excel!
    fullName: font
    summary: Returns the font object defined on the overall range.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'font?: Excel.Interfaces.RangeFontData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeFontData:interface" />'
  - name: horizontalAlignment
    uid: 'excel!Excel.Interfaces.RangeFormatData#horizontalAlignment:member'
    package: excel!
    fullName: horizontalAlignment
    summary: Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" |
        "CenterAcrossSelection" | "Distributed";
      return:
        type: >-
          <xref uid="excel!Excel.HorizontalAlignment:enum" /> | "General" | "Left" | "Center" | "Right" | "Fill" |
          "Justify" | "CenterAcrossSelection" | "Distributed"
  - name: protection
    uid: 'excel!Excel.Interfaces.RangeFormatData#protection:member'
    package: excel!
    fullName: protection
    summary: Returns the format protection object for a range.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'protection?: Excel.Interfaces.FormatProtectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.FormatProtectionData:interface" />'
  - name: rowHeight
    uid: 'excel!Excel.Interfaces.RangeFormatData#rowHeight:member'
    package: excel!
    fullName: rowHeight
    summary: 'The height of all rows in the range. If the row heights are not uniform, `null` will be returned.'
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rowHeight?: number;'
      return:
        type: number
  - name: verticalAlignment
    uid: 'excel!Excel.Interfaces.RangeFormatData#verticalAlignment:member'
    package: excel!
    fullName: verticalAlignment
    summary: Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";'
      return:
        type: '<xref uid="excel!Excel.VerticalAlignment:enum" /> | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"'
  - name: wrapText
    uid: 'excel!Excel.Interfaces.RangeFormatData#wrapText:member'
    package: excel!
    fullName: wrapText
    summary: >-
      Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a
      uniform wrap setting
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'wrapText?: boolean;'
      return:
        type: boolean