GetSheetAt Method

Summary

Retrieves a sheet from the Excel workbook by its index. Provides access to a sheet based on its position within the workbook.

Syntax

TypeScript
JavaScript
LEADWorkbook.prototype.getSheetAt = function( 
   index 
) 
getSheetAt( 
   index: number 
): Sheet; 

Parameters

index

A zero-based index of the sheet to retrieve. The index reflects the sheet's position in the workbook, starting from 0 for the first sheet.

Return Value

The Sheet object located at the specified index within the workbook. If the index is out of bounds, either negative or exceeding the last index of the workbook's sheets, an exception will be thrown.

Requirements

Target Platforms

See Also

LEADWorkbook Class

LEADWorkbook Members

Leadtools.Document.SheetEditor Namespace

Help Version 23.0.2024.5.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.SheetEditor Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.