ig.excel.CellFillPattern

An immutable object which represents a solid or pattern fill for a cell.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_core.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.excel.CellFillPattern
    Constructor

    new $.ig.excel.CellFillPattern( backgroundColorInfo:ig.excel.WorkbookColorInfo, patternColorInfo:ig.excel.WorkbookColorInfo, patternStyle:ig.excel.FillPatternStyle );

    Creates a new CellFillPattern instance.

    • backgroundColorInfo
    • Type:ig.excel.WorkbookColorInfo
    • A WorkbookColorInfo which describes the background color of the cell, which will only be seen if the patternStyle is not None.
    • patternColorInfo
    • Type:ig.excel.WorkbookColorInfo
    • A WorkbookColorInfo which describes the pattern color of the cell, which will only be seen if the patternStyle is not None or Solid.
    • patternStyle
    • Type:ig.excel.FillPatternStyle
    • The fill pattern for the cell.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException patternStyle is Default or not defined in the FillPatternStyle enumeration.

    Remarks

    backgroundColorInfo and patternColorInfo can be specified as null to use the default colors.

  • backgroundColorInfo

    .backgroundColorInfo( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Gets the WorkbookColorInfo which describes the background color of the cell, which will only be seen if the CellFillPattern.patternStyle is not None.

  • equals

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object is equal to this instance; False otherwise.

    Determines whether the CellFillPattern is equal to the specified object.

    • obj
    • Type:object
    • The object to test for equality.
  • getHashCode

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A number which can be used to hash this instance.

    Gets the hash code for the CellFillPattern.

  • patternColorInfo

    .patternColorInfo( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Gets the WorkbookColorInfo which describes the pattern color of the cell, which will only be seen if the CellFillPattern.patternStyle is not None or Solid.

  • patternStyle

    .patternStyle( );
    Return Type:
    ig.excel.FillPatternStyle
    Return Type Description:
    Returns a FillPatternStyle.

    Gets the fill pattern for the cell.

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