ig.excel.WorkbookStyle

Represents a complex format which can be applied to a cell's format.

Remarks

When a style is applied to a cell by setting its CellFormat.Style property, the cell's format will pick up subsequent changes to the format properties set by the style when it was applied. This will continue to happen until those format properties are set to other values on the cell format.

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.
  • isBuiltIn

    .isBuiltIn( );

    Gets the value indicating whether the style is a built in style in Microsoft Excel.

  • name

    .name( );
    Return Type:
    string
    Return Type Description:
    The name of the workbook style.

    Gets the name of the workbook style.

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is assigned and the style is a built.
    ig.ArgumentException The value assigned is null or empty.
    ig.ArgumentException The value assigned is longer than 255 characters.
    ig.ArgumentException The value assigned matches the name of another style in the collection.

    Remarks

    The style names must be case-insensitively unique and the names for built in styles cannot be changed.

  • name

    .name( value:string );
    Return Type:
    string
    Return Type Description:
    The name of the workbook style.

    Sets the name of the workbook style.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is assigned and the style is a built.
    ig.ArgumentException The value assigned is null or empty.
    ig.ArgumentException The value assigned is longer than 255 characters.
    ig.ArgumentException The value assigned matches the name of another style in the collection.

    Remarks

    The style names must be case-insensitively unique and the names for built in styles cannot be changed.

  • reset

    .reset( );

    Resets the style to its original state.

    Remarks

    If this is a user defined style, the format of the style will be reset so that it provides no formatting properties. If this is a built in style, this format will revert back to its preset state if it has previously been changed.

  • styleFormat

    .styleFormat( );
    Return Type:
    ig.excel.IWorksheetCellFormat
    Return Type Description:
    The cell format which applies to the workbook style.

    Gets the cell format which applies to the workbook style.

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