API

• Aug 09, 2019

The Spreadsheet provides a comprehensive API, allowing you to manipulate the document programmatically.

Server-Side API

On the server side, the Spreadsheet control is represented by the BootstrapSpreadsheet class.

To open an existing spreadsheet file, call the Open method. To create a new file, use the New method. A workbook with one empty worksheet is also created while creating a new BootstrapSpreadsheet instance.

The Document property provides access to a document currently loaded into the control.

ASPX

<dx:BootstrapSpreadsheet runat="server" ID="Spreadsheet" Height="500px">

</dx:BootstrapSpreadsheet>

C#

protected void Page_Load(object sender, EventArgs e) {
   if(!IsPostBack)
       Spreadsheet.Open(Server.MapPath("~/App_Data/Documents/MonthlyBudget.xlsx"));
}

Note

The BootstrapSpreadsheet control internally uses a comprehensive server-side API (a set of interfaces, methods, events, and commands) implemented by the Spreadsheet Core Library to access the document from code. This API is not publicly exposed at the BootstrapSpreadsheet control level.

Client-Side API

• The Spreadsheet’s client API is available through the BootstrapClientSpreadsheet class. It provides information about the current settings of the main document model elements and allows you to modify selected element settings.