Documentation

Class Workbook

A collection of sheets.

Inheritance
System.Object
NotifyPropertyChangedBase
Workbook
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class Workbook : NotifyPropertyChangedBase, INotifyPropertyChanged, IDisposable

Constructors

Workbook()

Initializes a new instance of the Workbook class.

Declaration
public Workbook()

Properties

ActiveSheet

Gets or sets the active sheet.

Declaration
public Sheet ActiveSheet { get; set; }
Property Value
Sheet

The active sheet.

ActiveTabIndex

Gets or sets the index of the active tab.

Declaration
public int ActiveTabIndex { get; set; }
Property Value
System.Int32

The index of the active tab.

ActiveWorksheet

Gets or sets the active worksheet.

Declaration
public Worksheet ActiveWorksheet { get; set; }
Property Value
Worksheet

The active worksheet.

DocumentInfo

Gets or sets the metadata information for the document file.

Declaration
public DocumentInfo DocumentInfo { get; set; }
Property Value
DocumentInfo

The document information.

History

Gets the history for this workbook.

Declaration
public WorkbookHistory History { get; }
Property Value
WorkbookHistory

The history for this workbook.

IsLayoutUpdateSuspended

Gets a value indicating whether the layout update is suspended.

Declaration
public bool IsLayoutUpdateSuspended { get; }
Property Value
System.Boolean

The value indicating whether the layout update is suspended.

IsProtected

Gets a value indicating whether the workbook is protected.

Declaration
public bool IsProtected { get; }
Property Value
System.Boolean

The is protected.

Name

Gets the name of the workbook.

Declaration
public string Name { get; set; }
Property Value
System.String

The name of the workbook.

Names

Gets the collection of defined names of the workbook.

Declaration
public NameCollection Names { get; }
Property Value
NameCollection

The collection of defined names of the workbook.

Sheets

Gets the sheets of the workbook.

Declaration
public SheetCollection Sheets { get; }
Property Value
SheetCollection

The sheets of the workbook.

Styles

Gets the collection of styles for this workbook.

Declaration
public CellStyleCollection Styles { get; }
Property Value
CellStyleCollection

The collection of styles for this workbook.

Theme

Gets or sets the workbook theme.

Declaration
public DocumentTheme Theme { get; set; }
Property Value
DocumentTheme

The workbook theme.

WorkbookContentChangedInterval

Gets or sets the interval on which the workbook content changes.

Declaration
public TimeSpan WorkbookContentChangedInterval { get; set; }
Property Value
System.TimeSpan

The interval on which the workbook content changes.

Worksheets

Gets the worksheets of the workbook.

Declaration
public WorksheetCollection Worksheets { get; }
Property Value
WorksheetCollection

The worksheets of the workbook.

Methods

CallOnWorkbookContentChanged()

Calls the on workbook content changed.

Declaration
protected void CallOnWorkbookContentChanged()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

Dispose(Boolean)

Disposes the specified clean up managed resources.

Declaration
protected virtual void Dispose(bool cleanUpManagedResources)
Parameters
System.Boolean cleanUpManagedResources

The clean up managed resources.

Find(FindOptions)

Executes find action according to the specified find options.

Declaration
public FindResult Find(FindOptions findOptions)
Parameters
FindOptions findOptions

The find options.
Returns
FindResult

The find results.

FindAll(FindOptions)

Executes find all action according to the specified find options.

Declaration
public IEnumerable<FindResult> FindAll(FindOptions findOptions)
Parameters
FindOptions findOptions

The find options.
Returns
System.Collections.Generic.IEnumerable<FindResult>

The find results.

OnActiveSheetChanged()

Called when the active sheet is changed.

Declaration
protected virtual void OnActiveSheetChanged()

OnCommandError(CommandErrorEventArgs)

Raises the CommandError event.

Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)
Parameters
CommandErrorEventArgs args

The CommandErrorEventArgs instance containing the event data.

OnCommandExecuted(CommandExecutedEventArgs)

Raises the CommandExecuted event.

Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs args)
Parameters
CommandExecutedEventArgs args

The CommandExecutedEventArgs instance containing the event data.

OnCommandExecuting(CommandExecutingEventArgs)

Raises the CommandExecuting event.

Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs args)
Parameters
CommandExecutingEventArgs args

The CommandExecutingEventArgs instance containing the event data.

OnIsProtectedChanged()

Called when [is protected changed].

Declaration
protected virtual void OnIsProtectedChanged()

OnThemeChanged()

Called when [theme changed].

Declaration
protected virtual void OnThemeChanged()

OnWorkbookContentChanged()

Called when [workbook content changed].

Declaration
protected virtual void OnWorkbookContentChanged()

Protect(String)

Protects the workbook with the specified password.

Declaration
public void Protect(string password)
Parameters
System.String password

The password.

Replace(ReplaceOptions)

Executes replace action in the active worksheet according to the specified replace options.

Declaration
public bool Replace(ReplaceOptions replaceOptions)
Parameters
ReplaceOptions replaceOptions

The replace options.
Returns
System.Boolean

The value indicating whether a value was found to replace.

ReplaceAll(ReplaceOptions)

Executes replace all action according to the specified replace options.

Declaration
public int ReplaceAll(ReplaceOptions replaceOptions)
Parameters
ReplaceOptions replaceOptions

The replace options.
Returns
System.Int32

The number of replacements made.

ResumeLayoutUpdate()

Resumes the layout update.

Declaration
public void ResumeLayoutUpdate()

SuspendLayoutUpdate()

Suspends the layout update.

Declaration
public void SuspendLayoutUpdate()

Unprotect(String)

Unprotects the workbook using the specified password.

Declaration
public bool Unprotect(string password)
Parameters
System.String password

The password.
Returns
System.Boolean

Events

ActiveSheetChanged

Occurs when the active sheet is changed.

Declaration
public event EventHandler ActiveSheetChanged
Event Type
System.EventHandler

CommandError

Occurs in a command error.

Declaration
public event EventHandler<CommandErrorEventArgs> CommandError
Event Type
System.EventHandler<CommandErrorEventArgs>

CommandExecuted

Occurs when a command has executed.

Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecuted
Event Type
System.EventHandler<CommandExecutedEventArgs>

CommandExecuting

Occurs when a command is in a state of execution.

Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecuting
Event Type
System.EventHandler<CommandExecutingEventArgs>

IsProtectedChanged

Occurs when the current protection state has changed.

Declaration
public event EventHandler IsProtectedChanged
Event Type
System.EventHandler

NameChanged

Occurs when name is changed.

Declaration
public event EventHandler NameChanged
Event Type
System.EventHandler

ThemeChanged

Occurs when a theme is changed.

Declaration
public event EventHandler ThemeChanged
Event Type
System.EventHandler

WorkbookContentChanged

Occurs when the workbook content is changed.

Declaration
public event EventHandler WorkbookContentChanged
Event Type
System.EventHandler