[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
   Reporting
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Scheduler
  [Collapse]Spreadsheet
    Product Structure
   [Expand]Getting Started
   [Collapse]Spreadsheet Document
     Workbook
     Worksheet
     Cell and Cell Range
     Rows and Columns
     Shapes, Pictures, Charts
     Comments
    Supported Formats
   [Expand]Cell Basics
   [Expand]Formulas
    Defined Names
    Data Binding
    Data Validation
   [Expand]Data Presentation
   [Expand]Pivot Table Overview
   [Expand]Charting Overview
    Shapes
    Printing
    Protection
    Find and Replace
   [Expand]Mail Merge
   [Expand]Visual Elements
    Services
    Themes and Templates
   [Expand]Shortcuts
   [Expand]Examples
  [Expand]Rich Text Editor
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Printing-Exporting
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Workbook

A workbook is a document in the SpreadsheetControl. It is an object that exposes the IWorkbook interface. The IWorkbook interface provides a set of properties and methods required to manipulate the workbook. To access a workbook that is currently loaded in the SpreadsheetControl, use the SpreadsheetControl.Document property. This is the starting point for using the Spreadsheet API.

A workbook consists of one or more worksheets stored within the WorksheetCollection collection. To access this collection, use the IWorkbook.Worksheets property. Each worksheet has a unique name and position within the workbook. Thus, you can access an individual worksheet by its name or index via the WorksheetCollection.Item property.

Use other WorksheetCollection object properties to manage the workbook's set of worksheets (add a new worksheet, remove an existing worksheet, assign an active worksheet, etc.).

A workbook may also contain specific sheets that display only a chart and do not have other data. These sheets are called chart sheets and are stored in the ChartSheetCollection collection returned by the IWorkbook.ChartSheets property. The ChartSheetCollection.Item property enables you to get an individual chart sheet by its name or index in the collection.

The IWorkbook.Sheets collection stores all sheets (worksheets and chart sheets) contained in a workbook. Use this collection when you need to access a sheet of any type.

By default, when you create a SpreadsheetControl instance, it contains a workbook with one empty worksheet ("Sheet1"). The same workbook is also created when you call the SpreadsheetControl.CreateNewDocument or IWorkbook.CreateNewDocument method. To load an existing document into a SpreadsheetControl, use the SpreadsheetControl.LoadDocument or IWorkbook.LoadDocument method. To save a workbook after all modifications are complete, use the SpreadsheetControl.SaveDocument or IWorkbook.SaveDocument method. The Supported Formats topic lists the file formats supported for loading and saving workbooks.

You can print a workbook via the SpreadsheetControl.Print method. Use the Worksheet.PrintOptions property to set print options for each individual worksheet.

A workbook contains a collection of styles, which can be used to format cell appearance in any worksheet. To access and modify this collection (for example, add new styles or modify existing styles), use the IWorkbook.Styles property.

The IWorkbook.DefinedNames collection includes cell, formula and constant defined names that can be used in any worksheet within the workbook without qualification. See the Defined Names topic for more information.

The IWorkbook.DocumentSettings property provides access to an object whose members you can use to customize different workbook settings. For example, you can specify whether the R1C1 reference style should be used in a workbook (DocumentSettings.R1C1ReferenceStyle), or set different workbook calculation options (DocumentSettings.Calculation).

You can also specify other workbook options using the corresponding properties of an object returned by SpreadsheetControl.Options or IWorkbook.Options.

Expanded See Also

Is this topic helpful?​​​​​​​