Workbook Methods
A non-visual component providing complete spreadsheet functionality.
You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this class in production code.
| Name | Description |
|---|---|
| AddService(Type, ServiceCreatorCallback, Boolean) |
Adds the specified service to the service container. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| AddService(Type, ServiceCreatorCallback) |
Adds the specified service to the service container. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| AddService(Type, Object, Boolean) |
Adds the specified service to the service container. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| AddService(Type, Object) |
Adds the specified service to the service container. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| BeginUpdate() |
Locks the Workbook object until the Workbook.EndUpdate method is called. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| Calculate() |
Forces recalculation of the workbook. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| Calculate(Range) | Forces recalculation of the specified cell range in a worksheet. |
| Calculate(Worksheet) | Forces recalculation of the specified worksheet in a workbook. |
| CalculateFull() | Forces a full calculation of the data in a workbook. |
| CalculateFullRebuild() | Forces a full calculation of the data and rebuilds the dependencies. |
| CancelUpdate() | For internal use. Use the Workbook.EndUpdate method instead. |
| CreateNewDocument() |
Creates and loads a new empty workbook. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| Dispose() |
Releases resources associated with a Workbook instance. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| EndUpdate() |
Unlocks the Workbook object. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| Evaluate(String, FormulaEvaluationContext) |
Evaluates the specified formula in a certain context. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| Evaluate(String) |
Evaluates the specified formula. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| ExportToHtml(Stream, Range) |
Exports the specified range to the specified stream in HTML format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(Stream, Worksheet) |
Exports the specified worksheet to the specified stream in HTML format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(Stream, HtmlDocumentExporterOptions) |
Exports the document’s data to the specified stream in HTML format using the specified options. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(Stream, Int32) |
Exports the specified worksheet to the specified stream in HTML format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(String, Range) |
Exports the specified range to the specified file in HTML format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(String, Worksheet) |
Exports the specified worksheet to the specified file in HTML format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(String, HtmlDocumentExporterOptions) |
Exports the document’s data to the specified file in HTML format using the specified options. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToHtml(String, Int32) |
Exports the specified worksheet to the specified file in HTML format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToPdf(Stream, PdfExportOptions) |
Exports the workbook to the specified stream in PDF format using the specified options. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToPdf(Stream) |
Exports the workbook to the specified stream in PDF format. You require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| ExportToPdf(String) |
Exports the workbook to the specified file path in PDF format. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| GenerateMailMergeDocuments() |
Performs a mail merge and returns the collection of resulting workbooks. You require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| GetService<T>() |
Gets the specified service. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| LoadDocument(Byte[], DocumentFormat) | Loads a document in the specified format from a byte array. |
| LoadDocument(Byte[]) | Loads a document from a byte array. |
| LoadDocument(Stream, DocumentFormat) |
Loads a document in the specified format from a stream. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| LoadDocument(Stream) | Loads a document from a stream. |
| LoadDocument(String, DocumentFormat) |
Loads a document in the specified format from a file. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| LoadDocument(String) |
Loads a document from a file. You require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| Print() |
Prints the document to the default printer. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| Print(PrinterSettings) |
Prints the document using the specified printer settings. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
| Protect(String, Boolean, Boolean) | Protects the structure and windows of a workbook. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RemoveService(Type, Boolean) |
Removes the service of the specified type from the service container. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| RemoveService(Type) |
Removes the service of the specified type from the service container. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| ReplaceService<T>(T) |
Performs a service substitution. You require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code. |
| SaveDocument(DocumentFormat) | Saves a document to a byte array in the specified format. |
| SaveDocument(Stream, DocumentFormat, EncryptionSettings) |
Saves the document to a stream in the specified format and with the specified encryption settings. You require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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 require a license to the DevExpress Office File API 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. |