Class Workbook

Namespace

FileFormat.Cells

Assembly

FileFormat.Cells.dll

Represents an Excel workbook with methods for creating, modifying, and saving content.

public class Workbook : IDisposable

Inheritance

object

Workbook

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Workbook()

Default constructor to create a new workbook.

public Workbook()

Workbook(string)

Overloaded constructor to open an existing workbook from a file.

public Workbook(string filePath)

Parameters

filePath string

Fields

spreadsheetDocument

protected SpreadsheetDocument spreadsheetDocument

Field Value

SpreadsheetDocument

stylesPart

protected WorkbookStylesPart stylesPart

Field Value

WorkbookStylesPart

workbookpart

protected WorkbookPart workbookpart

Field Value

WorkbookPart

worksheetPart

protected WorksheetPart worksheetPart

Field Value

WorksheetPart

Properties

BuiltinDocumentProperties

Get or set built-in document properties of the workbook.

public BuiltInDocumentProperties BuiltinDocumentProperties { get; set; }

Property Value

BuiltInDocumentProperties

DefaultStyleId

Get the ID of the default style.

public uint DefaultStyleId { get; }

Property Value

uint

Worksheets

public List<Worksheet> Worksheets { get; }

Property Value

List<Worksheet>

Methods

AddSheet(string)

Add a new worksheet to the workbook.

public Worksheet AddSheet(string sheetName)

Parameters

sheetName string

Returns

Worksheet

CopySheet(string, string)

Copies an existing sheet within the workbook to a new sheet.

public bool CopySheet(string sourceSheetName, string newSheetName)

Parameters

sourceSheetName string

The name of the sheet to be copied.

newSheetName string

The name of the new sheet to be created.

Returns

bool

Returns true if the sheet is successfully copied; otherwise, false.

CreateStyle(string, double, string)

Create a custom style for the workbook.

public uint CreateStyle(string fontName, double fontSize, string hexColor)

Parameters

fontName string

fontSize double

hexColor string

Returns

uint

Dispose()

This method releases unmanaged resources.

public void Dispose()

Dispose(bool)

Releases the unmanaged resources and optionally releases the managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

GetHiddenSheets()

Retrieves a list of hidden or very hidden sheets from the workbook.

public List<Tuple<string, string>> GetHiddenSheets()

Returns

List<Tuple<string, string>>

A list of tuples where each tuple contains the sheet ID and sheet name for hidden sheets.

Exceptions

InvalidOperationException

Thrown when the workbook part is not initialized.

ArgumentNullException

Thrown when a sheet's ID or Name is null.

RemoveSheet(string)

Remove a worksheet from the workbook.

public bool RemoveSheet(string sheetName)

Parameters

sheetName string

Returns

bool

RenameSheet(string, string)

Renames an existing sheet within the workbook.

public bool RenameSheet(string existingSheetName, string newSheetName)

Parameters

existingSheetName string

The current name of the sheet to be renamed.

newSheetName string

The new name for the sheet.

Returns

bool

Returns true if the sheet is successfully renamed; otherwise, false.

ReorderSheets(string, int)

Reorders a sheet within the workbook to a new position.

public void ReorderSheets(string sheetName, int newPosition)

Parameters

sheetName string

The name of the sheet to be reordered.

newPosition int

The new position (index) where the sheet should be moved.

Save()

Save the workbook using the original file path.

public void Save()

Save(Stream)

Save the workbook to a given stream.

public void Save(Stream stream)

Parameters

stream Stream

Save(string)

Save the workbook to a specified file path.

public void Save(string filePath)

Parameters

filePath string

SetSheetVisibility(string, SheetVisibility)

Sets the visibility of a sheet within the workbook.

public void SetSheetVisibility(string sheetName, SheetVisibility visibility)

Parameters

sheetName string

The name of the sheet whose visibility is to be set.

visibility SheetVisibility

The visibility state to be applied to the sheet (Visible, Hidden, or VeryHidden).

Exceptions

ArgumentException

Thrown when the sheet is not found in the workbook.

UpdateDefaultStyle(string, double, string)

Update the default style of the workbook.

public void UpdateDefaultStyle(string newFontName, double newFontSize, string hexColor)

Parameters

newFontName string

newFontSize double

hexColor string