Devexpress spreadsheet workbook class

Devexpress spreadsheet workbook class. Mar 1, 2024 · In this example, a worksheet containing a table with data is loaded in a Workbook instance. Use the Worksheet. In this case, the method returns the null value since the client-side control stores the values only for a small area about the displayed data cells. Macros Property. Update () Method. ExportToPdf method to generate a PDF file. Releases resources associated with a Workbook instance. TableStyleMedium27]; // Access table columns and name them. The document is used by more than one end Workbook. Subsequently, all extension methods become accessible as methods of objects, exposing the IWorkbook interface ( SpreadsheetControl The WorksheetExtensions class is defined in the DevExpress. Skip to main content. Each row is numbered (“1”, “2”, “3”, …, “1048576”), and each column is lettered (“A”, “B”, “C”, …, “XFD”). The Spreadsheet control displays Excel workbooks containing formulas, data sources, pivot tables, charts, and other advanced Excel capabilities with a great deal of precision. ShowHeadings), zoom a worksheet view (WorksheetView. Saves a document to a byte array in the specified format. Core Public Class WorkbookOptions Inherits This example demonstrates how to create a copy of an existing worksheet. For details on how to access an individual cell or range of cells, refer to the How to: Access a Cell in a Worksheet or How A worksheet is a grid of cells organized into 1,048,576 rows and 16,384 columns. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this assembly in production code. dataSource: Object: An object that is the data source for import. DevExpress. CreateArea(String, IBrickGraphics) When implemented by a class, creates report elements (bricks) for a specific area. Insert and RangeExtensions. A WorksheetDisplayArea class instance can be accessed through the ASPxSpreadsheet. CalculateFullRebuild() Forces a full calculation of cell formulas in a workbook. Dispose () Method. To access this object, use the CellRange. Range rangeA1D3 = worksheet. NET application with absolute ease. You can also get hyperlinks contained in the specified cell range via the HyperlinkCollection. Has. Prints a document using the default or custom printer settings defined by the PrinterSettings class instance. Item property. EndUpdate method is called. To do this, use the HyperlinkCollection. CalculateFull() Forces a full calculation of the data in a workbook. LoadDocument method to load an existing document from a file, a stream, or byte array into the Spreadsheet control. Form controls controls are interactive elements (buttons, checkboxes, and drop-down lists) that can be added to a worksheet to create user-friendly interfaces. The Spreadsheet Suite doesn't provide the capability to read files in this format. Mail-Merge, Printing and Export to PDF. To apply a number format to a cell range, call the CellRange. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this assembly in production code. CopyFrom method with the source worksheet object passed as a parameter. Create a new ExcelSourceOptions class instance and specify settings used to import data from the source workbook. A document loaded into the spreadsheet control is a workbook that exposes the IWorkbook interface and is accessible using the SpreadsheetControl. To export a file to PDF or HTML, use the Workbook. To set general page options, specify the WorksheetView properties. Print. Merge. WPF UI Controls. ActiveWorksheet property. Worksheet cells can contain Sep 5, 2016 · To use the Workbook class, it is necessary to add a reference to the DevExpress. Xlsb); Excel 5. Sep 19, 2023 · The Workbook class is defined in the DevExpress. SpreadsheetControl Oct 18, 2021 · To export a workbook to a PDF document that supports the PDF/A Conformance Level A (Accessible), create a PdfExportOptions class instance and set the PdfExportOptions. If your situation is different, please describe this task in Workbook. Checked ' Create a data table with column names obtained from the first row in a range Developer documentation for all DevExpress products. Range usedRange = workSheet. To enable workbook extensions, add a reference to the DevExpress. ShowGridlines), show or hide row and column headings (WorksheetView. To delete cells, use the Worksheet. WinForms Spreadsheet WPF Spreadsheet. The WorkbookExportOptions class instance is accessible via the DocumentOptions. Merge(book1, book2); If workbooks being merged contain worksheets with the same name, the added worksheets are automatically renamed and all cell references containing the duplicating worksheet names are updated to use the new names. Should you have further questions, let me know. v23. dll assembly. Add this assembly to your project to use worksheet extensions. Parse("C6:D9:E7"); // A rectangular range whose left column index is 0, top row index is 0, // right column index is 3 and bottom row index is 2. Method. NET Core) project. You can access and modify document theme in code. Options. The image below shows the worksheet that is set as the active worksheet in a workbook (“Sheet2”). This property returns the CellValue object, whose properties can be used to obtain the cell value type or get the value itself. Add method with the cell or cell range into which a hyperlink should be inserted, the target web page, or the workbook location passed along with other parameters. 2 > Public Class WorkbookCapabilitiesOptions Inherits To add a new worksheet under the specified name to the workbook, use the WorksheetCollection. Install the DevExpress. Style = workbook. Locks the Workbook object until the Workbook. The attached document is in the BIFF5 (Excel 5. We have no immediate plans to support this format in our Spreadsheet Suite. TableActions. The example below uses the Workbook class that is defined in the DevExpress. You can also use the WorksheetExtensions. Styles Property. SetSize method to specify a worksheet area that is visible and allows user input. ToObject method performs an inverse operation - it gets objects from cell values. Import; Remarks. Export ; Worksheet worksheet = spreadsheetControl1. Delete extension methods, defined by the RangeExtensions class. The IWorkbook interface provides a comprehensive set of properties To export a workbook to a PDF document that supports the PDF/A Conformance Level A (Accessible), create a PdfExportOptions class instance and set the PdfExportOptions. Developer documentation for all DevExpress products. HasMacros Property. 2 . Comments property and call the CommentCollection. CopyFrom method copy data from one worksheet to another. $899. Cell data are sorted using default built-in comparer. Instance. For instance, if you’re trying to merge workbooks containing worksheets named Sep 19, 2023 · The Workbook class is defined in the DevExpress. Worksheets(0) ' Create sorting fields. Workbook extensions are defined by the WorkbookExtensions class. Options or IWorkbook. Processor . Namespace: DevExpress. Turn the contents of your workbook or specific worksheets into a printed report or file with a simple method call or using the Print Dialog. Add(worksheet["B2:F5"], true); // Format the table by applying a built-in table style. Export property of an object returned by SpreadsheetControl. Forces recalculation of the specified worksheet in a workbook. As for the second question, you can export a document to a stream in CSV format and then read a string value from the stream, for example, as follows: C#. Create a WorksheetCopyOptions instance and pass it to this method to specify copy options. Sheet. A document loaded into the spreadsheet control is a workbook that exposes the IWorkbook interface and is accessible via the ASPxSpreadsheet. CreateDataTable method to create a DataTable based on the first row of the range containing data for export. Use the WorksheetDisplayArea. Export to PDF Reporting made easy. Document. The following options are available: Option. 1 assembly into your project. Oct 2, 2022 · The Spreadsheet control ships with the Name Box and Name Manager that allow users to create, view, edit, and delete names. We extended the list of supported document formats for our Spreadsheet Document API and WinForms/WPF Spreadsheet controls. GetDataSource method returns a data source which is subsequently used to create a report in a RichEditControl. firstColumnIndex: Int32 Nov 29, 2023 · Form Controls in Spreadsheet Control for Win. By a cell reference (for example, A1, B2, etc. Import property of an object returned by SpreadsheetControl. Pass a DocumentFormat enumeration member to the method to define the document format. Load a Workbook into the Spreadsheet Control. Add this assembly to your project to use the Workbook API. Namespace : DevExpress. ttf") Dim workbook As IWorkbook Spreadsheet. By a column index or column heading from the Remarks. To enable them, add a reference to the DevExpress. Remarks. Add method. Documents () Method. To enable worksheet extensions, add a reference to the DevExpress. To create a new note and associate it with a cell, access the worksheet’s collection of notes from the Worksheet. Example. The file format is identified by the file extension. Contains method for this purpose. This feature is still on our radar, and perhaps we will implement it in the future. Text values are sorted depending on the current culture, numbers are sorted smallest to largest, dates and times are sorted oldest to newest. You need a license for the DevExpress Office File API Subscription  or DevExpress Universal Subscription  to use this property in production code. BeginUpdateFormatting method for this range, set the Apr 5, 2023 · The WinForms Spreadsheet control emulates Microsoft® Excel® capabilities and allows you to create, load, edit, save, and print spreadsheet documents. PasteOptions. IsEmpty property is set to true ). Selection. Hello, To accomplish this task, use the Worksheet. . cs; TableActions. Core. Drawing Imports DevExpress. The DevExpress WinForms Spreadsheet control allows you to create high-impact business data analysis solutions that emulate the look, feel and capabilities of Microsoft Excel®. In this case, an optimal solution is to create a new document using the SpreadsheetControl. Data. The SpreadsheetControl class specifies a visual control to create, load, modify, print, save and convert spreadsheet documents in different formats. Mail. ViewType), and change print settings (WorksheetView. Selection; bool rangeHasHeaders = this. Use the SpreadsheetControl. Spreadsheet Control API. The code below demonstrates how to convert cell values of different types to objects and add them to an Developer documentation for all DevExpress products. Use built-in dialogs to customize page margins, document orientation, paper size, add headers/footer, incorporate page numbers, cu Oct 17, 2016 · DevExpress engineers feature-complete Presentation Controls, IDE Productivity Tools, Business Application Frameworks, and Reporting Systems for Visual Studio, Delphi, HTML5 or iOS & Android development. (Document. firstRowIndex: Int32: An integer that is the row index of the start cell in which the imported data will be inserted. Format Note Content To apply different fonts to specific regions of the comment text, modify the CommentRunCollection collection returned by the Comment. dll Range rangeC6D9E7 = worksheet. barCheckItemHasHeaders1. The Active view for the worksheet is accessible via the Worksheet. Functions property. Another way to merge and unmerge a cell range is to use the range’s RangeExtensions. UnMergeCells method. table. Worksheets collection. regular. Nov 28, 2023 · How to: Store a Workbook in the Database. Saves the document to a file in the Excel or text format. Document property. AddFont("Fonts\advent-pro. Hi, I would like to check if a worksheet with a name "What I'm Looking For" exists in a Workbook loaded in Devexpress spread sheet control. dll library and explicitly import the DevExpress. To modify worksheet data before they are exposed as data source fields, the application utilizes a custom MyPictureProvider converter Workbook result = Workbook. Row and column headings are displayed at the left and at the top of a worksheet, respectively. Sheets Property. using DevExpress. GetUsedRange(); After that you can use the RowCount and ColumnCount properties of this range. Add or WorksheetCollection. Start Visual Studio and create a new Console Application (. The CellValue. The DevExpress Spreadsheet Document API supports a broad range of 2D and 3D chart types. NET Core Application. A WorksheetDataBinding establishes two-way data binding by default. The Spreadsheet control allows you to add shapes and pictures to worksheets. This is the A1:D3 cell range. When creating an exporter, make sure that the Sep 19, 2023 · The WorksheetExtensions class is defined in DevExpress. Export; Remarks. By a column index or column heading from the Download your free 30-day trial today and see why your peers consistently vote DevExpress #1. ExportToHtml methods. Spreadsheet Imports DevExpress. The following members return WorkbookImportOptions objects:. This method removes an active hyperlink from a cell, but leaves its descriptive text formatted as a hyperlink. Instantiate a DataTableExporter object. Path Property. Ribbon. The following members return WorkbookExportOptions objects:. You need a license for the DevExpress Office File API Subscription  or DevExpress Universal Subscription  to use this method in production code. // Set the second worksheet ("Sheet2") as the active worksheet. Provides access to the workbook’s collection of cell styles. SpreadsheetControl. Each cell in a worksheet has a value that is specified by the CellValue object. Access the newly created worksheet object and call its Worksheet. FromObject methods allow you to convert objects of different types to SpreadsheetControl -compatible cell values. Orientation, WorksheetView The Range. ClearHyperlinks method. DeleteCells method (see the How to: Delete a Cell or Range of Cells example). All shape types are supported: from simple lines and rectangles to 3D shapes with advanced effects. New formats include: Excel Binary Workbook (XLSB) workbook. created 11 years ago (modified 11 years ago) Hi, In your scenario, I recommend you obtain a used cell range by using the WorkSheet. Docs. Columns. 0/95 Workbook (BIFF5) To remove any hyperlinks contained in a cell or cell range, call the Worksheet. Value property. Form controls are available in the following formats: Jun 19, 2017 · Unless I am mistaken, you wish to unload the resulting document from the SpreadsheetControl instance. Apr 22, 2022 · Create a new ExcelWorksheetSettings object and specify the worksheet with the WorksheetName property. The Spreadsheet uses Microsoft Excel number formats  to display cell numbers as percentage, decimal, currency, accounting, and date/time values. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code. Pass the class instance to the Workbook. TableStyles[BuiltInTableStyleId. Oct 10, 2014 · created 10 years ago. XtraSpreadsheet Assembly : DevExpress. Hello Kia, You can use the WorksheetCollection. Fires when the selection changes in a worksheet. dll assembly and explicitly import the DevExpress. dll. A cell value can be constant, or it can be calculated dynamically (if the cell contains a formula ). GetHyperlinks method and remove them Oct 6, 2013 · DevExpress Support Team. You need a license to the DevExpress Office File API or DevExpress Universal Subscription to use this assembly in production code. This example demonstrates several ways to access individual cells. . I recommend you review the "How to: Specify Row Height or Column Width" help topic for additional information. LoadDocument("Documents\Sortsample. Paste the code below in the Main method of the Program class ( Main procedure of the Module1 module in Visual Basic). Selection Dim rangeHasHeaders As Boolean = Me. Open the Program. AutoFit method. Runs property. To export a worksheet range to a DataTable, perform the following steps. XtraBars. NET Ribbon control so you can deliver Excel inspired functionality with minimal Workbook. It can load, convert and save workbooks to the XLS-XLSx binary file format and can export and import XLSX, CSV and TXT files. Oct 29, 2019 · Spreadsheet – Breaking Change in v19. Forms. 2 Developer documentation for all DevExpress products. NET Spreadsheet control for Web Forms and MVC allows you to create high-impact business data analysis solutions that emulate the look, feel and capabilities of Microsoft Excel®. Save. Whether using WPF, ASP. Assembly : DevExpress. Use the CellCollection. Document property to access a workbook loaded into the SpreadsheetControl. PdfACompatibility property to one of the following values: PdfA1a, PdfA2a, or PdfA3a. Checked; // Create a data table with column names obtained Dim workbook As New Workbook() Dim printOptions As WorkbookPrintOptions = workbook. Use the WorkbookFunctions. Table table = worksheet. First column (offset = 0) will be sorted using ascending order. ttf") DXFontRepository. To do this, assign the required value to the Range. Determines whether the workbook has VBA projects (macros). Spreadsheet. BeginUpdate () Method. workbook. BeginUpdate () Locks the Workbook object until the Workbook. However, if a worksheet range is bound to the read-only data source, the range itself is also read-only and its data are not updated. Create a new DataTable  instance. AddPicture method overloads. If a cell does not contain any data, the cell value is empty (the CellValue. ActiveWorksheet Dim range As CellRange = worksheet. Shapes and Pictures. v 23. Gets the file name into which the workbook is saved or from which it is loaded. The IWorkbook interface represents a spreadsheet document. Spreadsheet Namespace WinFormsSpreadsheet Public Class Form1 Inherits DevExpress. Begin. Core and Dec 2, 2015 · DevExpress Support Team. You can call extension methods in the same way as instance methods of the Worksheet object. If you are new to the SpreadsheetControl or consider it for an upcoming project, review the following topics first: Get Started with the WinForms Spreadsheet. Imports DevExpress. For example, call the WorksheetCollection. An object of the WorkbookFunctions class is available by using the IWorkbook. Changed Event. Gets or sets a specific data member in a data source that contains several tables or members. Use built-in dialogs to customize page margins, document orientation, paper size, add headers/footer, incorporate page numbers, cu Apr 22, 2022 · How to: Set an Active Worksheet. The method might return an irrelevant value of the specified cell in the following cases: The specified cell is placed far from the displayed data cells. It includes full integration with the DevExpress Ribbon control so you can deliver Excel inspired functionality with minimal effort. Dim fields As New List(Of SortField)() ' First sorting field. It includes full integration with the DevExpress ASP. Generate. May 10, 2022 · This example demonstrates several ways to access individual cells. CreateNewDocument method. Spreadsheet namespace into the code with a using directive ( Imports in Visual Basic). To apply a number format to a cell, use the Cell object’s NumberFormat property. Create an empty worksheet in a workbook. OverrideFunction method to override a worksheet built-in function. UnMerge extension methods, defined by the RangeExtensions class. In this case, the previous document will be automatically closed. ExportToPdf and Workbook. In our most recent major release, we extended the list of supported chart types and added support for Excel 2016 charts (Box and Whisker, Funnel, Histogram, Sunburst, Treemap, Waterfall, and Pareto). Name Type Description; rowOffset: Int32: An integer value that specifies the zero-based offset of the last row to be frozen relative to the first row in a worksheet. Tables. Jan 3, 2017 · Answers approved by DevExpress Support. v16. Prints a particular sheet in the document. NET Spreadsheet allows you to incorporate spreadsheet functionality to any ASP. Description. WorksheetDisplayArea property. cs (Module1. The WorkbookImportOptions class instance is accessible via the DocumentOptions. Processor NuGet package. AddFont("Fonts\Roboto-Light. Workbook. The following example demonstrates how to save a worksheet as an image and set thumbnail options: May 5, 2022 · The SpreadsheetControl provides the following methods to print a workbook or individual worksheets. If a worksheet range is bound to the data source which allows change notifications, such as a data source with the IBindingList  interface sheet: Worksheet: A Worksheet that is the worksheet to which the data is imported. ActiveWorksheet; CellRange range = worksheet. Merge and RangeExtensions. xlsb", DocumentFormat. Insert method with the worksheet name passed as a parameter. These controls allow users to input or manage data. Nov 29, 2022 · Imports DevExpress. 0/95) format. Provides options to restrict an end-user’s ability to manage worksheets of the workbook loaded into SpreadsheetControl. The SpreadsheetControl class specifies a visual control that allows you to create, load, modify, print, save and convert spreadsheet documents in different formats. Assign the ExcelWorksheetSettings object to the ExcelSourceOptions. DocumentOptions. To unmerge cells, use the Worksheet. Pass the class instance to the IWorkbook. Print Access print options for a workbook in the Spreadsheet control : C# AddService(Type, Object) Adds the specified service to the service container. Format) Method. ImportSettings property. Workbook workbook = new Workbook(); Developer documentation for all DevExpress products. NuGet Package : DevExpress. Worksheets. vb // Insert a table in the worksheet. NET, WinForms, HTML5 or Windows 10, DevExpress tools help you build and deliver your best in the shortest time possible. Specifies the part of data to paste from the copied worksheet into the target worksheet. FromLTRB(0, 0, 3, 2); // A range that includes the intersection of two ranges: C5:E10 and E9:G13. As you can see the reference to the class Workbook is not recognized by Visual Studio even though my project and the class that contains the method have a reference to either DevExpress. The code is displayed in screenshot 1. (String) Method. 2. This example demonstrates how to create a hyperlink to a web page or cell range in a workbook. Spreadsheet. To set an active worksheet within a workbook, assign the corresponding Worksheet object to the WorksheetCollection. Sheets Property. By row and column indexes of a cell via the Worksheet. Home. LoadDocument("BinaryWorkbook. Export Dim worksheet As Worksheet = spreadsheetControl1. A workbook can be saved to a byte array in one of the available formats specified by the DocumentFormat enumeration by using the SpreadsheetControl. xlsx") Dim worksheet As Worksheet = workbook. Example This example demonstrates how to rename a worksheet. 99. 2 minutes to read. Performs a mail merge and returns the collection of resulting workbooks. Jul 8, 2021 · Important. Member Property. Another way to insert and delete the cell range is to use the range’s RangeExtensions. SaveDocument method. ) or by row and column indexes from the worksheet’s collection of cells. C#. When the file format is not specified, the May 2, 2014 · I want to create a workbook in code without a visible spreadsheet control using the workbook class. Range. ActiveView property. Spreadsheet . RibbonForm Public Sub New() InitializeComponent() DXFontRepository. Print. GetUsedRange method: C#. Value property of the cell or range object. Provides access to a collection of all sheets contained in the workbook. The DevExpress ASP. You can store the array of bytes in the varbinary field of the data record in the MS SQL Server database. Spreadsheet namespace into the code with the using directive ( Imports in Visual Basic). The method requires the function to be replaced and a custom function with which the built-in function will be replaced. The Table. Jul 25, 2021 · A workbook consists of one or more worksheets stored in the IWorkbook. Feb 9, 2024 · Create a . Zoom), select a worksheet tab color (WorksheetView. When you create a SpreadsheetControl instance, it contains a workbook with an empty worksheet. The DocumentFormat enumeration lists the supported document formats. Spreadsheet namespace into your source code with a using directive ( Imports in Visual Basic). Static methods of the SpreadsheetImageSource allow you to create an image to embed into a worksheet via the PictureCollection. To do this, follow the steps below. TabColor) and view type (WorksheetView. vb) file. Dec 12, 2022 · The following code demonstrates how to export a selected range to a DataTable. Use the WorksheetView object’s members to specify the visibility of gridlines (WorksheetView. The ASPxSpreadsheet class specifies a visual control to create, load, modify, print, save and convert spreadsheet files. This example demonstrates how set print options to create the printout as required. Document. LoadDocument or IWorkbook. Options, Workbook. Use the WorksheetCollection members to add a new worksheet, remove an existing worksheet, rename a worksheet, select an active worksheet, and so on. Nov 28, 2023. You need a license for the DevExpress Office File API Subscription  or DevExpress Universal Subscription  to use this event in production code. SetValue and CellValue. kk xh xk xv bu mg ci xa ll hp