Workbook.EndUpdate() Method

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.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public void EndUpdate()

VB.NET

Public Sub

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.

C#

// 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.
    Range 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.
    Range 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();
}

VB.NET

' Create a new document.
Dim workbook As New Workbook()

workbook.BeginUpdate()
Try
    Dim worksheet As Worksheet = workbook.Worksheets(0)
    workbook.Unit = DevExpress.Office.DocumentUnit.Point

    ' Create a multiplication table.
    worksheet.Cells("A1").Value = "*"
    For i As Integer = 1 To 10
        ' Create a header column.
        worksheet.Columns("A")(i).Value = i
        ' Create a header row.
        worksheet.Rows("1")(i).Value = i
    Next i

    ' Multiply values of header cells.
    worksheet.Range("B2:K11").Formula = "=B$1*$A2"

    ' Obtain the data range.
    Dim tableRange As Range = 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.
    Dim headerCells As Range = worksheet.Range.Union(worksheet.Range("A1:K1"), worksheet.Range("A2:A11"))
    headerCells.FillColor = Color.FromArgb(&Hf7, &H9b, &H77)
    headerCells.Font.Bold = True

    ' Fill cells that contain multiplication results.
    worksheet.Range("B2:K11").FillColor = Color.FromArgb(&Hfe, &Hf2, &He4)
Finally
    workbook.EndUpdate()
End Try

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EndUpdate() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.cs#L57

{
    workbook.EndUpdate();
}

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/CodeExamples/SeriesActions.cs#L97

workbook.EndUpdate();
#endregion #ChangeSeriesArgumentsAndValues

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/Form1.cs#L85

    workbook.Worksheets.ActiveWorksheet.Visible = true;
    workbook.EndUpdate();
}

VB.NET

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.vb#L31

Finally
    workbook.EndUpdate()
End Try

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/CodeExamples/SeriesActions.vb#L100

workbook.EndUpdate()
'            #End Region ' #ChangeSeriesArgumentsAndValues

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/Form1.vb#L80

    workbook.Worksheets.ActiveWorksheet.Visible = True
    workbook.EndUpdate()
End Sub