OfficeIMO

API Reference

Class

SheetIndex

Edit on GitHub
Namespace OfficeIMO.Excel.Fluent
Assembly OfficeIMO.Excel
Source OfficeIMO.Excel/Fluent/SheetIndex.cs:17
Modifiers static

Convenience helpers for creating a navigable index (Table of Contents) sheet and wiring back-links across the workbook. Thin wrapper over ExcelDocument APIs.

Inheritance

  • Object
  • SheetIndex

Methods

public static Void Add(ExcelDocument workbook, String sheetName = "TOC", Boolean placeFirst = true, Boolean includeNamedRanges = false, Boolean includeHiddenNamedRanges = false) #
OfficeIMO.Excel/Fluent/SheetIndex.cs:17
Returns: Void

Adds a styled Table of Contents sheet with hyperlinks to each sheet.

Parameters

workbook OfficeIMO.Excel.ExcelDocument requiredposition: 0
Target workbook.
sheetName System.String = "TOC" optionalposition: 1
Name of the TOC sheet. Default: "TOC".
placeFirst System.Boolean = true optionalposition: 2
Move TOC to the first position. Default: true.
includeNamedRanges System.Boolean = false optionalposition: 3
Whether to add a column listing named ranges per sheet.
includeHiddenNamedRanges System.Boolean = false optionalposition: 4
Include hidden named ranges in the listing.