ig.excel.Chartsheet

A sheet in a Mirosoft Excel workbook that displays a single chart.

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.

  • chart

    .chart( );
    Return Type:
    ig.excel.WorksheetChart
    Return Type Description:
    Returns a WorksheetChart.

    Returns the WorksheetChart displayed in this chartsheet.

    See Also

  • displayOptions

    .displayOptions( );
    Return Type:
    ig.excel.ChartsheetDisplayOptions
    Return Type Description:
    The object which controls the display of the chartsheet.

    Gets the object which controls the display of the chartsheet.

    Remarks

    The display options include any settings which affect the display of the chartsheet when viewed in Microsoft Excel. These settings will not affect the printed chartsheet or the data stored in the chartsheet.

    See Also

  • hasProtectionPassword
    Inherited

    .hasProtectionPassword( );

    Returns a boolean indicating if the Sheet has been protected with a password.

    Remarks

    When protecting a Sheet, a password is optional. The HasProtectionPassword will return true if the Sheet is currently protected (see Sheet.isProtected) and a password was specified when it was protected.

    See Also

  • isProtected
    Inherited

    .isProtected( );

    Returns a boolean indicating if the Worksheet has been protected.

    Remarks

    The IsProtected property will return true if the Worksheet is currently protected. When a Worksheet is protected only unprotected cells may be edited. In addition, other operations may be limited based on the properties of the WorksheetProtection which may be accessed using the Protection property.

    See Also

  • moveToSheetIndex
    Inherited

    .moveToSheetIndex( index:number );

    Moves the sheet to a new position in the owning workbook's collections of sheets.

    • index
    • Type:number
    • The new 0-based index to where the sheet should be moved.

    Exceptions

    Exception Description
    ig.InvalidOperationException The sheet has previously been removed from its workbook.
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to the number of sheets in the owning workbook.

    See Also

  • name
    Inherited

    .name( );
    Return Type:
    string
    Return Type Description:
    The sheet name.

    Gets the sheet name.

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is null or empty.
    ig.ArgumentException The value assigned contains the invalid characters: ':', '\', '/', '?', '*', '[', or ']'.
    ig.ArgumentException The value assigned exceeds 31 characters in length.
    ig.ArgumentException The value assigned is being used as the name of another sheet (sheet names are case-insensitively compared).

    Remarks

    The sheet name is case-insensitively unique in the workbook.

    The sheet name is shown in the tab for the worksheet. In addition, the worksheet name can be used by formulas from other worksheets to refer to cells in this worksheet.

  • name
    Inherited

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

    Sets the sheet name.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is null or empty.
    ig.ArgumentException The value assigned contains the invalid characters: ':', '\', '/', '?', '*', '[', or ']'.
    ig.ArgumentException The value assigned exceeds 31 characters in length.
    ig.ArgumentException The value assigned is being used as the name of another sheet (sheet names are case-insensitively compared).

    Remarks

    The sheet name is case-insensitively unique in the workbook.

    The sheet name is shown in the tab for the worksheet. In addition, the worksheet name can be used by formulas from other worksheets to refer to cells in this worksheet.

  • printOptions

    .printOptions( );
    Return Type:
    ig.excel.ChartsheetPrintOptions
    Return Type Description:
    The object which controls how the chartsheet prints.

    Gets the object which controls how the chartsheet prints.

    See Also

  • protect

    .protect( [allowEditObjects:boolean], [allowEditContents:boolean] );

    Protects the chartsheet without a password.

    • allowEditObjects
    • Type:boolean
    • Optional
    • Optional boolean indicating the new value for the ChartsheetProtection.allowEditObjects.
    • allowEditContents
    • Type:boolean
    • Optional
    • Optional boolean indicating the new value for the AllowEditScenarios.

    Remarks

    When a Chartsheet is protected without a password, the end user may unprotect the Chartsheet in Excel without having to supply a password. To programatically unprotect a Chartsheet, one may use the Unprotect() method.

    The optional parameters are used to update the property values of the ChartsheetProtection instance from this Worksheet's Chartsheet.protection property. If the parameter is null, the current value of the associated property will be retained; otherwise the property will be updated with the specified value. For example, if the ChartsheetProtection.allowEditObjects is currently true and the allowEditObjects is null, then the property will continue to be true but if the allowEditObjects is false the ChartsheetProtection.allowEditObjects will be changed to false.

    Note: If IsProtected is already true, the method will be ignored.

    See Also

  • protection

    .protection( );
    Return Type:
    ig.excel.ChartsheetProtection
    Return Type Description:
    Returns a ChartsheetProtection.

    Returns an object that provides information used when the Chartsheet has been protected.

    See Also

  • selected
    Inherited

    .selected( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether this worksheet is selected.

    Gets the value which indicates whether this worksheet is selected.

    Remarks

    If the worksheet has been removed from its parent Workbook.worksheets collection, this will always return False.

    See Also

  • sheetIndex
    Inherited

    .sheetIndex( );
    Return Type:
    number
    Return Type Description:
    The zero-based index of this sheet in its parent Sheets collection.

    Gets the zero-based index of this sheet in its parent Workbook.sheets collection.

    Remarks

    Negative one indicates the sheet has been removed from its parent collection.

    See Also

  • tabColorInfo
    Inherited

    .tabColorInfo( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel.

    Gets the WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel.

    Remarks

    If the tab bar is not visible, this color will not be seen.

    See Also

  • tabColorInfo
    Inherited

    .tabColorInfo( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    The WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel.

    Sets the WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel.

    • value
    • Type:ig.excel.WorkbookColorInfo

    Remarks

    If the tab bar is not visible, this color will not be seen.

    See Also

  • type

    .type( );
    Return Type:
    ig.excel.SheetType
    Return Type Description:
    Returns a SheetType.

    Returns Chartsheet

    See Also

  • unprotect
    Inherited

    .unprotect( );

    Removes the Sheet protection.

    See Also

  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    The Workbook that owns the worksheet.

    Gets the Sheet.workbook that owns the worksheet.

    See Also

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