.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

Workbook Members

A non-visual component that provides complete spreadsheet functionality. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this class in production code.

Constructors

Name Description
Workbook() Initializes a new instance of the Workbook class with the default settings.

Properties

Name Description
ChartSheets Provides access to a collection of chart sheets contained in the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Clipboard Provides access to the object used for working with the system clipboard. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
CurrentAuthor Gets the system username. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
CustomFunctions Provides access to a collection of custom functions in a workbook You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
CustomXmlParts Provides access to a workbook's collection of custom XML parts. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
DefinedNames Gets the collection of defined names whose scope is the current workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
DocumentProperties Provides access to the document properties associated with a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
DocumentSettings Provides access to the settings that specify how the calculation is performed and what reference style is used. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
ExternalWorkbooks Provides access to the collection of source workbooks used for creating external references in the current workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
FormulaEngine Provides access to an object used to parse and evaluate formulas. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Functions Provides access to the built-in functions in a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
GlobalCustomFunctions Provides access to a collection of custom functions which are not limited in scope to the workbook in which the functions reside. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
HasMacros Determines whether the workbook has VBA projects (macros). You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
History Provides access to the history of operations performed in a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
IsDisposed Indicates whether a workbook has been disposed of. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
IsProtected Indicates whether a workbook is protected. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
IsUpdateLocked Returns a value indicating whether the Workbook object is locked for update. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
MailMergeDataMember Gets or sets a specific data member in a data source that contains several tables or members. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
MailMergeDataSource Gets or sets the data source for the mail merge. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
MailMergeOptions Provides access to mail merge options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
MailMergeParameters Provides access to a collection of query parameters used to obtain data in mail merge. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Model For internal use.
Modified Gets or sets whether the workbook content was modified since it was last saved. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Options Provides access to the variety of options which can be specified for the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Path Gets the file name into which the workbook is saved or from which it is loaded. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
PivotCaches Returns the collection of all PivotTable caches in a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Range Provides access to the cell range in the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
RealTimeData Returns an object used to manually update real-time data and reconnect to data servers. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Sheets Provides access to a collection of all sheets contained in the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Styles Provides access to the workbook's collection of cell styles. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
TableStyles Provides access to the collection of styles to format tables in the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Tag Gets or sets data associated with a Workbook object. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Unit Gets or sets a unit of measure used in the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Worksheets Returns the collection of worksheets in a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.

Methods

Name Description
AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
AddService(Type, ServiceCreatorCallback, Boolean) Adds the specified service to the service container. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
AddService(Type, Object) Adds the specified service to the service container. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
AddService(Type, Object, Boolean) Adds the specified service to the service container. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
BeginUpdate() Locks the Workbook object until the Workbook.EndUpdate method is called. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Calculate() Forces recalculation of the workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Calculate(CellRange) Forces recalculation of the specified cell range in a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Calculate(Worksheet) Forces recalculation of the specified worksheet in a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
CalculateFull() Forces a full calculation of a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
CalculateFullRebuild() Forces a full calculation of a workbook and rebuilds the dependencies. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
CancelUpdate() For internal use. Use the Workbook.EndUpdate method instead.
CreateNewDocument() Creates and loads a new empty workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Dispose() Releases resources associated with a Workbook instance. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
EndUpdate() Unlocks the Workbook object. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Evaluate(String) Evaluates the specified formula. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Evaluate(String, FormulaEvaluationContext) Evaluates the specified formula in a certain context. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(Stream, CellRange) Exports the specified range to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(Stream, Worksheet) Exports the specified worksheet to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(Stream, HtmlDocumentExporterOptions) Exports the document's data to the specified stream in HTML format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(Stream, Int32) Exports the specified worksheet to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(String, CellRange) Exports the specified range to the specified file in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(String, Worksheet) Exports the specified worksheet to the specified file in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(String, HtmlDocumentExporterOptions) Exports the document's data to the specified file in HTML format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtml(String, Int32) Exports the specified worksheet to the specified file in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, CellRange) Asynchronously exports the specified range to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, CellRange, CancellationToken) Asynchronously exports the specified range to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, Worksheet) Asynchronously exports the specified worksheet to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, Worksheet, CancellationToken) Asynchronously exports the specified range to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, HtmlDocumentExporterOptions) Asynchronously exports the document's data to the specified stream in HTML format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, HtmlDocumentExporterOptions, CancellationToken) Asynchronously exports the document's data to the specified stream in HTML format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, Int32) Asynchronously exports the specified range to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(Stream, Int32, CancellationToken) Asynchronously exports the specified worksheet to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, CellRange) Asynchronously exports the specified worksheet to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, CellRange, CancellationToken) Asynchronously exports the specified range to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, Worksheet) Asynchronously exports the specified worksheet to the specified file in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, Worksheet, CancellationToken) Asynchronously exports the specified worksheet to the specified file in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, HtmlDocumentExporterOptions) Asynchronously exports the document's data to the specified file in HTML format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, HtmlDocumentExporterOptions, CancellationToken) Asynchronously exports the document's data to the specified file in HTML format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, Int32) Asynchronously exports the specified worksheet to the specified file in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToHtmlAsync(String, Int32, CancellationToken) Asynchronously exports the specified worksheet to the specified stream in HTML format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(Stream) Exports the workbook to the specified stream in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(Stream, PdfExportOptions) Exports the workbook to the specified stream in PDF format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(Stream, PdfExportOptions, IEnumerable<String>) Defines export options and exports the specified sheets to the stream in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(Stream, PdfExportOptions, String[]) Defines export options and exports the specified sheets to the stream in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(String) Exports the workbook to the specified file path in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(String, PdfExportOptions) Exports the workbook to the specified file path in PDF format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(String, PdfExportOptions, IEnumerable<String>) Defines export options and exports the specified sheets to the file in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdf(String, PdfExportOptions, String[]) Defines export options and exports the specified sheets to the file in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream) Asynchronously exports the workbook to the specified stream in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream, PdfExportOptions) Asynchronously exports the workbook to the specified stream in PDF format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream, PdfExportOptions, IEnumerable<String>) Asynchronously exports the workbook to the specified file path in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream, PdfExportOptions, IEnumerable<String>, CancellationToken) Defines export options and asynchronously exports the specified sheets to the stream in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream, PdfExportOptions, String[]) Asynchronously exports specific worksheets to the specified file path in PDF format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream, PdfExportOptions, CancellationToken) Asynchronously exports the workbook to the specified stream in PDF format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(Stream, CancellationToken) Asynchronously exports the workbook to the specified stream in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String) Asynchronously exports the workbook to the specified file path in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String, PdfExportOptions) Asynchronously exports the workbook to the specified stream in PDF format using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String, PdfExportOptions, IEnumerable<String>) Defines export options and asynchronously exports the specified sheets to the file in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String, PdfExportOptions, IEnumerable<String>, CancellationToken) Defines export options and asynchronously exports the specified sheets to the file in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String, PdfExportOptions, String[]) Defines export options and asynchronously exports the specified sheets to the file in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String, PdfExportOptions, CancellationToken) Asynchronously exports the workbook to the specified file path in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ExportToPdfAsync(String, CancellationToken) Asynchronously exports the workbook to the specified file path in PDF format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
GenerateMailMergeDocuments() Performs a mail merge and returns the collection of resulting workbooks. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetService(Type) Gets the service object of the specified type. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
GetService<T>() Gets the specified service. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
GetType() Gets the Type of the current instance. Inherited from Object.
LoadDocument(Byte[]) Loads a document from a byte array. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocument(Byte[], DocumentFormat) Loads a document in the specified format from a byte array. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocument(Stream) Loads a document from a stream. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocument(Stream, DocumentFormat) Loads a document in the specified format from a stream. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocument(String) Loads a document from a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocument(String, DocumentFormat) Loads a document in the specified format from a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Byte[]) Loads a document asynchronously from a byte array. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Byte[], DocumentFormat) Loads a document asynchronously in the specified format from a byte array. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Byte[], DocumentFormat, CancellationToken) Loads a document asynchronously in the specified format from a byte array. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Byte[], CancellationToken) Loads a document asynchronously from a byte array. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Stream) Loads a document asynchronously from a stream. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Stream, DocumentFormat) Loads a document asynchronously in the specified format from a stream. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Stream, DocumentFormat, CancellationToken) Loads a document asynchronously in the specified format from a stream. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(Stream, CancellationToken) Loads a document asynchronously from a stream. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(String) Loads a document asynchronously from a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(String, DocumentFormat) Loads a document asynchronously in the specified format from a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(String, DocumentFormat, CancellationToken) Loads a document asynchronously in the specified format from a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
LoadDocumentAsync(String, CancellationToken) Loads a document asynchronously from a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Merge(IWorkbook[]) static Combines the specified workbooks into a new document. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Print() Prints the document to the default printer. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Print(PrinterSettings) Prints the document using the specified printer settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Print(PrinterSettings, IEnumerable<String>) Defines printer settings and prints the specified sheets. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Print(PrinterSettings, String[]) Defines printer settings and prints the specified sheets. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Protect(String, Boolean, Boolean) Protects the structure and windows of a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveService(Type) Removes the service of the specified type from the service container. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
RemoveService(Type, Boolean) Removes the service of the specified type from the service container. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ReplaceService<T>(T) Performs a service substitution. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(DocumentFormat) Saves a document to a byte array in the specified format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(DocumentFormat, EncryptionSettings) Saves the document to an array of bytes in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(Stream, DocumentFormat) Saves the document to a stream in the specified format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(Stream, DocumentFormat, EncryptionSettings) Saves the document to a stream in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(String) Saves the document to a file in the Excel or text format. The file format is identified by the file extension. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(String, DocumentFormat) Saves the document to a file in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(String, DocumentFormat, EncryptionSettings) Saves the document to a file in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocument(String, EncryptionSettings) Saves the document to a file in the Excel or text format with the specified encryption settings. The file format is identified by the file extension. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(DocumentFormat) Asynchronously saves the document to a byte array in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(DocumentFormat, EncryptionSettings) Asynchronously saves the document to an array of bytes in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(DocumentFormat, EncryptionSettings, CancellationToken) Asynchronously saves the document to an array of bytes in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(DocumentFormat, CancellationToken) Asynchronously saves the document to an array of bytes in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(Stream, DocumentFormat) Asynchronously saves the document to a stream in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(Stream, DocumentFormat, EncryptionSettings) Asynchronously saves the document to a stream in the specified document format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(Stream, DocumentFormat, EncryptionSettings, CancellationToken) Asynchronously saves the document to a stream in the specified document format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(Stream, DocumentFormat, CancellationToken) Asynchronously saves the document to a stream in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String) Asynchronously saves the document to a file in the Excel or text format. The file format is identified by the file extension. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, DocumentFormat) Asynchronously saves the document to a file in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, DocumentFormat, EncryptionSettings) Asynchronously saves the document to a file in the specified document format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, DocumentFormat, EncryptionSettings, CancellationToken) Asynchronously saves the document to a file in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, DocumentFormat, CancellationToken) Asynchronously saves the document to a file in the specified document format. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, EncryptionSettings) Asynchronously saves the document to a file with the specified encryption settings. The file format is identified by the file extension. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, EncryptionSettings, CancellationToken) Asynchronously saves the document to a file in the specified format and with the specified encryption settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
SaveDocumentAsync(String, CancellationToken) Asynchronously saves the document to a file. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Search(String) Performs a search in the current document by using the default parameters. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Search(String, SearchOptions) Performs a search in the current document by using the specified options. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
ToString() Returns a string that represents the current object. Inherited from Object.
Unprotect(String) Removes protection from a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Events

Name Description
ActiveSheetChanged Occurs after an active worksheet in a workbook has been changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ActiveSheetChanging Occurs when an active worksheet in a workbook is about to be changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
BeforeExport Occurs before the document is saved (exported to a certain format). You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
BeforeImport Occurs before a document is loaded (imported from an external source). You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
BeforePrintSheet Occurs before printing a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ClipboardDataObtained Occurs after data on the clipboard is obtained and recognized, but before data is actually pasted. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ClipboardDataPasted Occurs after data has been pasted from the clipboard onto a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ClipboardDataPasting Occurs before data is pasted into destination cells. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ColumnsInserted Occurs after new columns have been added to a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ColumnsInserting Occurs before new columns are added to a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ColumnsRemoved Occurs after columns have been deleted from a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ColumnsRemoving Occurs before columns are removed from a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ColumnWidthChanged Occurs after the column width was changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CommentInserted Occurs after a comment was inserted. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CommentInserting Occurs before a comment is inserted. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CommentRemoved Occurs after a comment was deleted. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CommentRemoving Occurs before a comment is deleted. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ContentChanged Occurs when a workbook's undo history changes. The Undo history is not logged for a Workbook instance by default, so the event is not raised. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CopiedRangePasted Occurs after the range content has been pasted into target cells. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CopiedRangePasting Occurs before the range content is pasted into target cells. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
CustomAssemblyLoading Occurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows cancelling loading. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
DefinedNameConflictResolving Occurs when the formula or sheet being moved or copied contains a defined name which already exists on the destination worksheet or workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
DocumentClosing Occurs when a document that has not yet been saved is about to be closed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
DocumentLoaded Occurs after a document is loaded. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
DocumentSaved Occurs after a document has been saved. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
EmptyDocumentCreated Occurs when a new document is created. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
EncryptedFileIntegrityCheckFailed Raises when the encrypted file did not pass the data integrity verification. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
EncryptedFilePasswordCheckFailed Occurs when the encryption password is empty or invalid. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
EncryptedFilePasswordRequest Raises when the WorkbookImportOptions.Password property is not set or contains a wrong password. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
InitializeDocument Occurs before a document is loaded. Handle this event to set initial document settings. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
InvalidFormatException Fires when the supplied data could not be recognized as data in the assumed format for import. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ModifiedChanged Occurs when the value of the Workbook.Modified property is changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
PanesFrozen Occurs after a worksheet area has been frozen. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
PanesUnfrozen Occurs after a frozen worksheet area has been unlocked. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RangeCopied Occurs after the range content has been copied. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RangeCopying Occurs before a cell range is copied in a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RowHeightChanged Occurs after the row height was changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RowsInserted Occurs after new rows have been added to a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RowsInserting Occurs before new rows are added to a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RowsRemoved Occurs after rows have been deleted from a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
RowsRemoving Occurs before rows are removed from a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SchemaChanged Occurs when a worksheet or defined name is renamed, inserted or deleted. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ScrollPositionChanged Occurs when the scroll position changes in a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SelectionChanged Fires when the selection changes in a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ShapeInserted Occurs after a drawing object has been inserted into a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ShapeRemoved Occurs after a drawing object has been removed from a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ShapeRemoving Occurs before a drawing object is removed from a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ShapesCopying Occurs before a drawing object is copied in a worksheet. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SheetInserted Occurs after a new worksheet has been added to a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SheetRemoved Occurs after a worksheet has been removed from a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SheetRemoving Occurs before a worksheet is removed from a workbook. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SheetRenamed Occurs after a worksheet has been renamed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
SheetRenaming Occurs when a worksheet is about to be renamed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
UnitChanged Fires after a unit of measurement used in the workbook is changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
UnitChanging Fires before a unit of measurement used within the workbook is changed. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
ValidateCustomSqlQuery Allows you to validate a custom SQL query created in the Data Source Wizard. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
See Also