ig.excel.WorkbookColorInfo

An immutable object which represents a color in a Microsoft Excel workbook.

Dependencies

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

  • ig.excel.WorkbookColorInfo
    Constructor

    new $.ig.excel.WorkbookColorInfo( color:string );

    Creates a new WorkbookColorInfo with the specified Color.

    • color
    • Type:string
    • The color which should be displayed when the WorkbookColorInfo is used.

    Exceptions

    Exception Description
    ig.ArgumentException color is the empty Color or has a non-opaque alpha channel.

  • ig.excel.WorkbookColorInfo
    Constructor

    new $.ig.excel.WorkbookColorInfo( color:string, tint:number );

    Creates a new WorkbookColorInfo with the specified Color and tint.

    • color
    • Type:string
    • The base color which should be displayed when the WorkbookColorInfo is used.
    • tint
    • Type:number
    • The tint to apply to the base color, from -1.0 (100% darken) to 1.0 (100% lighten).

    Exceptions

    Exception Description
    ig.ArgumentException color is the empty Color or has a non-opaque alpha channel.
    ig.ArgumentOutOfRangeException tint is outside the range of -1.0 to 1.0, inclusive.

  • ig.excel.WorkbookColorInfo
    Constructor

    new $.ig.excel.WorkbookColorInfo( themeColorType:ig.excel.WorkbookThemeColorType );

    Creates a new WorkbookColorInfo with the specified theme color.

    • themeColorType
    • Type:ig.excel.WorkbookThemeColorType
    • The type of theme color which should be displayed when the WorkbookColorInfo is used.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException themeColorType is not defined in the WorkbookThemeColorType enumeration.

  • ig.excel.WorkbookColorInfo
    Constructor

    new $.ig.excel.WorkbookColorInfo( themeColorType:ig.excel.WorkbookThemeColorType, tint:number );

    Creates a new WorkbookColorInfo with the specified theme color and tint.

    • themeColorType
    • Type:ig.excel.WorkbookThemeColorType
    • The type of theme color which should be the base color when the WorkbookColorInfo is used.
    • tint
    • Type:number
    • The tint to apply to the base color, from -1.0 (100% darken) to 1.0 (100% lighten).

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException themeColorType is not defined in the WorkbookThemeColorType enumeration.
    ig.ArgumentOutOfRangeException tint is outside the range of -1.0 to 1.0, inclusive.

  • automatic

    .automatic( );

    Gets the automatic color, which is the window text system color.

    See Also

  • color

    .color( );

    Gets the base color associated of the WorkbookColorInfo.

    See Also

  • equals

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

    Determines whether the WorkbookColorInfo 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 WorkbookColorInfo.

  • getResolvedColor

    .getResolvedColor( );
    Return Type:
    string
    Return Type Description:
    A Color which combines the WorkbookColorInfo.color and WorkbookColorInfo.tint if it is set.

    Gets the actual color which will be seen in Microsoft Excel if the WorkbookColorInfo is used.

    Exceptions

    Exception Description
    ig.ArgumentNullException The WorkbookColorInfo.themeColorType is not null. When the ThemeColorType is set, the WorkbookColorInfo.getResolvedColor method must be called with a non-null Workbook.

  • getResolvedColor

    .getResolvedColor( workbook:ig.excel.Workbook );
    Return Type:
    string
    Return Type Description:
    A Color which combines the WorkbookColorInfo.color, WorkbookColorInfo.themeColorType, and/or WorkbookColorInfo.tint, depending on what is set.

    Gets the actual color which will be seen in Microsoft Excel if the WorkbookColorInfo is used.

    • workbook
    • Type:ig.excel.Workbook
    • The workbook in which the WorkbookColorInfo is used.

    Exceptions

    Exception Description
    ig.ArgumentNullException workbook is null and WorkbookColorInfo.themeColorType is not null. When the ThemeColorType is set, the method must be called with a non-null Workbook.

  • isAutomatic

    .isAutomatic( );

    Gets the value which indicates whether the WorkbookColorInfo is automatic, or the window text system color.

  • l_op_Equality

    .l_op_Equality( a:ig.excel.WorkbookColorInfo, b:ig.excel.WorkbookColorInfo );

    • a
    • Type:ig.excel.WorkbookColorInfo
    • b
    • Type:ig.excel.WorkbookColorInfo

  • l_op_Implicit_WorkbookColorInfo_Color

    .l_op_Implicit_WorkbookColorInfo_Color( color:string );

    • color
    • Type:string

  • l_op_Implicit_WorkbookColorInfo_WorkbookThemeColorType

    .l_op_Implicit_WorkbookColorInfo_WorkbookThemeColorType( themeColorType:ig.excel.WorkbookThemeColorType );

    • themeColorType
    • Type:ig.excel.WorkbookThemeColorType

  • l_op_Inequality

    .l_op_Inequality( a:ig.excel.WorkbookColorInfo, b:ig.excel.WorkbookColorInfo );

    • a
    • Type:ig.excel.WorkbookColorInfo
    • b
    • Type:ig.excel.WorkbookColorInfo

  • op_Equality

    .op_Equality( a:ig.excel.WorkbookColorInfo, b:ig.excel.WorkbookColorInfo );
    Return Type:
    boolean
    Return Type Description:
    True if the WorkbookColorInfo instances are equal; False otherwise.

    Determines whether two WorkbookColorInfo instances are equal.

    • a
    • Type:ig.excel.WorkbookColorInfo
    • The first WorkbookColorInfo instance.
    • b
    • Type:ig.excel.WorkbookColorInfo
    • The second WorkbookColorInfo instance.

  • op_Implicit

    .op_Implicit( themeColorType:ig.excel.WorkbookThemeColorType );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo containing the specified theme color type.

    Converts from a WorkbookColorInfo.themeColorType to a WorkbookColorInfo.

    • themeColorType
    • Type:ig.excel.WorkbookThemeColorType
    • The theme color type to use in the WorkbookColorInfo.

  • op_Implicit

    .op_Implicit( color:string );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo containing the specified color.

    Converts from a Color to a WorkbookColorInfo.

    • color
    • Type:string
    • The color to use in the WorkbookColorInfo.

  • op_Inequality

    .op_Inequality( a:ig.excel.WorkbookColorInfo, b:ig.excel.WorkbookColorInfo );
    Return Type:
    boolean
    Return Type Description:
    True if the WorkbookColorInfo instances are unequal; False otherwise.

    Determines whether two WorkbookColorInfo instances are unequal.

    • a
    • Type:ig.excel.WorkbookColorInfo
    • The first WorkbookColorInfo instance.
    • b
    • Type:ig.excel.WorkbookColorInfo
    • The second WorkbookColorInfo instance.

  • themeColorType

    .themeColorType( );

    Gets the base theme color associated of the WorkbookColorInfo.

    See Also

  • tint

    .tint( );

    Gets the to apply to the base color, from -1.0 (100% darken) to 1.0 (100% lighten).

    See Also

  • toString

    .toString( );
    Return Type:
    string

    Gets the string representation of the WorkbookColorInfo.

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