Ignite UI API Reference

ig.excel.IWorkbookFont

Represents a font for the cell in the related context.

Remarks

If a property of a font has a default value, value of the previous font in resolution chain is used. The resolution priority is the following: Cell (highest priority) Row Column Default Cell Format (lowest priority) For example, if a column font is set to blue and bold and a row font is set to italic and not bold, the font in the cell at the intersection of the row and column would have blue, italic text in the saved workbook.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.
  • bold

    .bold( );

  • bold

    .bold( value:boolean );

    • value
    • Type:boolean
  • colorInfo

    .colorInfo( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The foreground color of the font.

    Gets the foreground color of the font.

  • colorInfo

    .colorInfo( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The foreground color of the font.

    Sets the foreground color of the font.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • height

    .height( );
    Return Type:
    number
    Return Type Description:
    The font height in twips (1/20th of a point).

    Gets the font height in twips (1/20th of a point).

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is positive and outside the valid font height range of 20 and 8180.

    Remarks

    A negative value indicates the default font height, in which case the default font height is used.

  • height

    .height( value:number );
    Return Type:
    number
    Return Type Description:
    The font height in twips (1/20th of a point).

    Sets the font height in twips (1/20th of a point).

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is positive and outside the valid font height range of 20 and 8180.

    Remarks

    A negative value indicates the default font height, in which case the default font height is used.

  • italic

    .italic( );

  • italic

    .italic( value:boolean );

    • value
    • Type:boolean
  • name

    .name( );
    Return Type:
    string
    Return Type Description:
    The font family name.

    Gets the font family name.

  • name

    .name( value:string );
    Return Type:
    string
    Return Type Description:
    The font family name.

    Sets the font family name.

    • value
    • Type:string
  • setFontFormatting

    .setFontFormatting( source:ig.excel.IWorkbookFont );

    Sets all font properties to specific font formatting.

    • source
    • Type:ig.excel.IWorkbookFont
    • Source font format.
  • strikeout

    .strikeout( );

  • strikeout

    .strikeout( value:boolean );

    • value
    • Type:boolean
  • superscriptSubscriptStyle

    .superscriptSubscriptStyle( );
    Return Type:
    ig.excel.FontSuperscriptSubscriptStyle
    Return Type Description:
    The value which indicates whether the font is superscript or subscript.

    Gets the value which indicates whether the font is superscript or subscript.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontSuperscriptSubscriptStyle enumeration.
  • superscriptSubscriptStyle

    .superscriptSubscriptStyle( value:ig.excel.FontSuperscriptSubscriptStyle );
    Return Type:
    ig.excel.FontSuperscriptSubscriptStyle
    Return Type Description:
    The value which indicates whether the font is superscript or subscript.

    Sets the value which indicates whether the font is superscript or subscript.

    • value
    • Type:ig.excel.FontSuperscriptSubscriptStyle

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontSuperscriptSubscriptStyle enumeration.
  • underlineStyle

    .underlineStyle( );
    Return Type:
    ig.excel.FontUnderlineStyle
    Return Type Description:
    The underline style of the font.

    Gets the underline style of the font.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontUnderlineStyle enumeration.
  • underlineStyle

    .underlineStyle( value:ig.excel.FontUnderlineStyle );
    Return Type:
    ig.excel.FontUnderlineStyle
    Return Type Description:
    The underline style of the font.

    Sets the underline style of the font.

    • value
    • Type:ig.excel.FontUnderlineStyle

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the FontUnderlineStyle enumeration.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.

#