excelscript.conditionalrangefont.yml

### YamlMime:TSType
name: ExcelScript.ConditionalRangeFont
uid: 'ExcelScript!ExcelScript.ConditionalRangeFont:interface'
package: ExcelScript!
fullName: ExcelScript.ConditionalRangeFont
summary: 'This object represents the font attributes (font style, color, etc.) for an object.'
remarks: |-


  #### Examples

  ```TypeScript
  /**
   * This script applies cell value conditional formatting to a range.
   * Any value less than 60 will have the cell's fill color changed and the font made italic.
   */
  function main(workbook: ExcelScript.Workbook) {
    // Get the range to format.
    const selectedRange = workbook.getSelectedRange();

    // Add cell value conditional formatting.
    const cellValueConditionalFormatting =
      selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();

    // Create the condition, in this case when the cell value is less than 60.
    const rule: ExcelScript.ConditionalCellValueRule = {
      formula1: "60",
      operator: ExcelScript.ConditionalCellValueOperator.lessThan
    };
    cellValueConditionalFormatting.setRule(rule);

    // Set the format to apply when the condition is met.
    const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
    const fill: ExcelScript.ConditionalRangeFill = format.getFill();
    const font: ExcelScript.ConditionalRangeFont = format.getFont();
    fill.setColor("yellow");
    font.setItalic(true);
  }
  ```
isPreview: false
isDeprecated: false
type: interface
methods:
  - name: clear()
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#clear:member(1)'
    package: ExcelScript!
    fullName: clear()
    summary: Resets the font formats.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'clear(): void;'
      return:
        type: void
        description: ''
  - name: getBold()
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getBold:member(1)'
    package: ExcelScript!
    fullName: getBold()
    summary: Specifies if the font is bold.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getBold(): boolean;'
      return:
        type: boolean
        description: ''
  - name: getColor()
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getColor:member(1)'
    package: ExcelScript!
    fullName: getColor()
    summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getColor(): string;'
      return:
        type: string
        description: ''
  - name: getItalic()
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getItalic:member(1)'
    package: ExcelScript!
    fullName: getItalic()
    summary: Specifies if the font is italic.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItalic(): boolean;'
      return:
        type: boolean
        description: ''
  - name: getStrikethrough()
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getStrikethrough:member(1)'
    package: ExcelScript!
    fullName: getStrikethrough()
    summary: Specifies the strikethrough status of the font.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getStrikethrough(): boolean;'
      return:
        type: boolean
        description: ''
  - name: getUnderline()
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getUnderline:member(1)'
    package: ExcelScript!
    fullName: getUnderline()
    summary: The type of underline applied to the font. See `ExcelScript.ConditionalRangeFontUnderlineStyle` for details.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getUnderline(): ConditionalRangeFontUnderlineStyle;'
      return:
        type: '<xref uid="ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum" />'
        description: ''
  - name: setBold(bold)
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setBold:member(1)'
    package: ExcelScript!
    fullName: setBold(bold)
    summary: Specifies if the font is bold.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setBold(bold: boolean): void;'
      parameters:
        - id: bold
          description: ''
          type: boolean
      return:
        type: void
        description: ''
  - name: setColor(color)
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setColor:member(1)'
    package: ExcelScript!
    fullName: setColor(color)
    summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setColor(color: string): void;'
      parameters:
        - id: color
          description: ''
          type: string
      return:
        type: void
        description: ''
  - name: setItalic(italic)
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setItalic:member(1)'
    package: ExcelScript!
    fullName: setItalic(italic)
    summary: Specifies if the font is italic.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setItalic(italic: boolean): void;'
      parameters:
        - id: italic
          description: ''
          type: boolean
      return:
        type: void
        description: ''
  - name: setStrikethrough(strikethrough)
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setStrikethrough:member(1)'
    package: ExcelScript!
    fullName: setStrikethrough(strikethrough)
    summary: Specifies the strikethrough status of the font.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setStrikethrough(strikethrough: boolean): void;'
      parameters:
        - id: strikethrough
          description: ''
          type: boolean
      return:
        type: void
        description: ''
  - name: setUnderline(underline)
    uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setUnderline:member(1)'
    package: ExcelScript!
    fullName: setUnderline(underline)
    summary: The type of underline applied to the font. See `ExcelScript.ConditionalRangeFontUnderlineStyle` for details.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setUnderline(underline: ConditionalRangeFontUnderlineStyle): void;'
      parameters:
        - id: underline
          description: ''
          type: '<xref uid="ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum" />'
      return:
        type: void
        description: ''