WorksheetCollection

WorksheetCollection

Overview

WorksheetCollection is a class in Aspose.Cells FOSS for C++.

Encapsulates the workbook’s worksheets and active-sheet state.

Properties

NameTypeAccessDescription
WorksheetCollectionWorksheetCollectionRead

Methods

SignatureDescription
WorksheetCollection()WorksheetCollectionInitializes a new instance of the WorksheetCollection class. The parent workbook. The underlying workbook model.
GetCount()intGets the total number of worksheets in the workbook.
GetActiveSheetIndex()intGets or sets the zero-based index of the active worksheet.
SetActiveSheetIndex(value: int)
GetActiveSheetName()std::stringGets or sets the name of the active worksheet.
SetActiveSheetName(value: std::string_view)
Add()intAdds a worksheet using the next generated default name. The zero-based index of the added worksheet.
Add(sheetName: std::string_view)intAdds a worksheet using the next generated default name. The zero-based index of the added worksheet.
RemoveAt(index: int)Removes the worksheet at the specified zero-based index. The zero-based index of the worksheet to remove.
RemoveAt(sheetName: std::string_view)Removes the worksheet at the specified zero-based index. The zero-based index of the worksheet to remove.
begin()std::vector<std::unique_ptr<Worksheet>>::const_iteratorReturns an iterator to the beginning of the worksheet collection.
end()std::vector<std::unique_ptr<Worksheet>>::const_iteratorReturns an iterator to the end of the worksheet collection.

See Also