ig.excel.Sheet
Dependencies
-
hasProtectionPassword
- .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.
-
isProtected
- .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.
-
moveToSheetIndex
- .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. -
name
- .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
- .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.
-
selected
- .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
- .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.
-
tabColorInfo
- .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.
-
tabColorInfo
- .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.
-
type
- .type( );
- Return Type:
- ig.excel.SheetType
- Return Type Description:
- Returns a SheetType.
Returns a value indicating the type of sheet
See Also
-
unprotect
- .unprotect( );
Removes the Sheet protection.
-
workbook
- .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