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

Workbook.BeginUpdate() Method

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.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v20.1.dll

Declaration

public void BeginUpdate()
Public Sub BeginUpdate

Remarks

Enclose your code in the BeginUpdate - EndUpdate() method calls to improve performance when you apply multiple modifications to a document.

Each call to BeginUpdate must be paired with the EndUpdate() call. You can use the try...finally statement to ensure that EndUpdate() is always called even if an exception occurs.

The following example shows how to use the BeginUpdate - EndUpdate() methods.


// Create a new document.
Workbook workbook = new Workbook();

workbook.BeginUpdate();
try
{
    Worksheet worksheet = workbook.Worksheets[0];
    workbook.Unit = DevExpress.Office.DocumentUnit.Point;

    // Create a multiplication table.
    worksheet.Cells["A1"].Value = "*";
    for(int i = 1; i < 11; i++)
    {
        // Create a header column.
        worksheet.Columns["A"][i].Value = i;
        // Create a header row.
        worksheet.Rows["1"][i].Value = i;
    }

    // Multiply values of header cells.
    worksheet.Range["B2:K11"].Formula = "=B$1*$A2";

    // Obtain the data range.
    CellRange tableRange = worksheet.GetDataRange();

    // Specify the row height and column width.
    tableRange.RowHeight = 40;
    tableRange.ColumnWidth = 40;

    // Align the table content.
    tableRange.Alignment.Horizontal = SpreadsheetHorizontalAlignment.Center;
    tableRange.Alignment.Vertical = SpreadsheetVerticalAlignment.Center;

    // Fill the header cells.
    CellRange headerCells = worksheet.Range.Union(worksheet.Range["A1:K1"], worksheet.Range["A2:A11"]);
    headerCells.FillColor = Color.FromArgb(0xf7, 0x9b, 0x77);
    headerCells.Font.Bold = true;

    // Fill cells that contain multiplication results.
    worksheet.Range["B2:K11"].FillColor = Color.FromArgb(0xfe, 0xf2, 0xe4);
}
finally
{
    workbook.EndUpdate();
}

Implements

DevExpress.Utils.IBatchUpdateable.BeginUpdate()
See Also