|
3 | 3 | [](https://supportcenter.devexpress.com/ticket/details/T217615) |
4 | 4 | [](https://docs.devexpress.com/GeneralInformation/403183) |
5 | 5 | <!-- default badges end --> |
| 6 | +# Spreadsheet Document API – How to Process Excel Workbooks in Code (Part 2) |
| 7 | + |
| 8 | +The [DevExpress Spreadsheet Document API](https://docs.devexpress.com/OfficeFileAPI/14912/spreadsheet-document-api) is a non-visual library that allows you to generate, import, export, modify, and print Microsoft Excel workbooks in code. |
| 9 | + |
| 10 | +> You need a license for the [DevExpress Office File API Subscription](https://www.devexpress.com/products/net/office-file-api/) or [DevExpress Universal Subscription](https://www.devexpress.com/subscriptions/universal.xml) to use this library in production code. |
| 11 | + |
| 12 | +This example demonstrates how to use the Spreadsheet Document API to execute the following actions: |
| 13 | + |
| 14 | +- Apply filters to a worksheet range (a dynamic filter, the "Top 10" filter, number, text, and date filters) |
| 15 | +- Save a worksheet in HTML format |
| 16 | +- Group and ungroup worksheet rows and columns |
| 17 | +- Outline worksheet data automatically |
| 18 | +- Create subtotals for a cell range |
| 19 | +- Insert a picture into a worksheet and modify an embedded picture |
| 20 | +- Protect and unprotect a workbook and worksheet |
| 21 | +- Protect specific worksheet ranges |
| 22 | +- Sort data in a range |
| 23 | +- Manage tables and table styles |
| 24 | +- Search for specific data in a worksheet |
| 25 | + |
| 26 | +The application form contains the list of supported operations and the editor that allows you to view and edit the source code for each operation. Select an operation, modify its code if necessary, and click **Open in Microsoft Excel** to open the resulting spreadsheet document in Microsoft Excel. |
| 27 | +If an error occurs during compilation or execution, the background color of the code editor changes to pink. |
| 28 | + |
| 29 | + |
| 30 | + |
6 | 31 | <!-- default file list --> |
7 | | -*Files to look at*: |
8 | | - |
9 | | -* [AutoFilterActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/AutoFilterActions.cs) (VB: [AutoFilterActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/AutoFilterActions.vb)) |
10 | | -* [ExportActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/ExportActions.cs) (VB: [ExportActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/ExportActions.vb)) |
11 | | -* [GroupAndOutlineActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/GroupAndOutlineActions.cs) (VB: [GroupAndOutlineActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/GroupAndOutlineActions.vb)) |
12 | | -* [PictureActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.cs) (VB: [PictureActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.vb)) |
13 | | -* [ProtectionActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/ProtectionActions.cs) (VB: [ProtectionActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/ProtectionActions.vb)) |
14 | | -* [SearchActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/SearchActions.cs) (VB: [SearchActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/SearchActions.vb)) |
15 | | -* [SortActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/SortActions.cs) (VB: [SortActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/SortActions.vb)) |
16 | | -* [TableActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/TableActions.cs) (VB: [TableActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/TableActions.vb)) |
| 32 | +## Files to Look At |
| 33 | + |
| 34 | +- [AutoFilterActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/AutoFilterActions.cs) (VB: [AutoFilterActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/AutoFilterActions.vb)) |
| 35 | +- [ExportActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/ExportActions.cs) (VB: [ExportActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/ExportActions.vb)) |
| 36 | +- [GroupAndOutlineActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/GroupAndOutlineActions.cs) (VB: [GroupAndOutlineActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/GroupAndOutlineActions.vb)) |
| 37 | +- [PictureActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.cs) (VB: [PictureActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.vb)) |
| 38 | +- [ProtectionActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/ProtectionActions.cs) (VB: [ProtectionActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/ProtectionActions.vb)) |
| 39 | +- [SearchActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/SearchActions.cs) (VB: [SearchActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/SearchActions.vb)) |
| 40 | +- [SortActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/SortActions.cs) (VB: [SortActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/SortActions.vb)) |
| 41 | +- [TableActions.cs](./CS/SpreadsheetDocServerAPIPart2/CodeExamples/TableActions.cs) (VB: [TableActions.vb](./VB/SpreadsheetDocServerAPIPart2/CodeExamples/TableActions.vb)) |
| 42 | + |
17 | 43 | <!-- default file list end --> |
18 | | -# Spreadsheet Document API - Part 2 |
19 | 44 |
|
| 45 | +## Documentation |
20 | 46 |
|
21 | | -This example demonstrates how to use the <a href="https://documentation.devexpress.com/OfficeFileAPI/14912/Spreadsheet-Document-API">Spreadsheet Document API</a> to programmatically manage spreadsheet documents, without the need for Microsoft Excel to be installed.<br>The application includes the <a href="https://documentation.devexpress.com/#WindowsForms/CustomDocument6975">RichEditControl</a> used to display and edit the code. The code modifies the spreadsheet document loaded in the <a href="https://documentation.devexpress.com/OfficeFileAPI/DevExpress.Spreadsheet.Workbook.class">Workbook</a> instance. To see the results, open the document in Microsoft Excel by clicking the button.<br>You can modify the code and watch the result. If an error occurs during compilation or execution, the backcolor of the code window changes.<br><br>This sample introduces API properties and methods used to perform the following operations:<br> |
22 | | -<p>- Insert, delete and modify pictures<br>- Add a hyperlink to a picture<br>- Create a table<br>- Apply a custom style to the table<br>- Protect a workbook<br>- Protect a worksheet<br>- Apply user-specific permissions to a range in a protected worksheet<br>- Sort a range in descending and ascending orders<br>- Sort by multiple columns<br>- Simple search<br>- Search with options <br>- Export to HTML<br>- Group and outline data<br>- Insert subtotals<br>- Filter data by a list of values<br>- Apply a number filter<br>- Apply a text filter <br>- Apply a dynamic filter<br>- Sort the filtered data<br><br>For more information, review the <a href="https://documentation.devexpress.com/OfficeFileAPI/12074/Spreadsheet-Document-API/Examples"><u>Examples</u></a> section in the documentation.<br><br>The<strong> Universal Subscription</strong> or an additional <strong>Office File API Subscription</strong> is required to use this example in production code. Please refer to the <a href="https://www.devexpress.com/Buy/NET/">DevExpress Subscription</a> page for pricing information.</p> |
23 | | -<br/> |
| 47 | +- [Filter Data](https://docs.devexpress.com/OfficeFileAPI/113729/spreadsheet-document-api/examples/filtering) |
| 48 | +- [Export a Document to HTML](https://docs.devexpress.com/OfficeFileAPI/113724/spreadsheet-document-api/examples/workbooks/how-to-export-a-document-to-html) |
| 49 | +- [Group Data](https://docs.devexpress.com/OfficeFileAPI/113730/spreadsheet-document-api/examples/grouping) |
| 50 | +- [Pictures](https://docs.devexpress.com/OfficeFileAPI/113733/spreadsheet-document-api/examples/pictures) |
| 51 | +- [Protection](https://docs.devexpress.com/OfficeFileAPI/113734/spreadsheet-document-api/examples/protection) |
| 52 | +- [Search](https://docs.devexpress.com/OfficeFileAPI/113731/spreadsheet-document-api/examples/search) |
| 53 | +- [Sorting](https://docs.devexpress.com/OfficeFileAPI/113728/spreadsheet-document-api/examples/sorting) |
| 54 | +- [Tables](https://docs.devexpress.com/OfficeFileAPI/403308/spreadsheet-document-api/spreadsheet-tables) |
24 | 55 |
|
25 | | -See also:<br/> |
26 | | -<a href="https://github.com/DevExpress-Examples/spreadsheet-document-api-examples-e4339">Spreadsheet Document API - Part 1</a> |
| 56 | +## More Examples |
27 | 57 |
|
28 | | -<a href="https://github.com/DevExpress-Examples/spreadsheet-document-api-part-3">Spreadsheet Document API - Part 3</a> |
| 58 | +- [Spreadsheet Document API - Part 1](https://github.com/DevExpress-Examples/spreadsheet-document-api-examples-part1) |
| 59 | +- [Spreadsheet Document API - Part 3](https://github.com/DevExpress-Examples/spreadsheet-document-api-part-3) |
0 commit comments