EndUpdate Method (IWorkbookSet)

Restores painting and events to the state they were in before the last call to BeginUpdate, releases the lock acquired by BeginUpdate, and starts background calculation if appropriate.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Sub EndUpdate()

'Usage
 
Dim instance As IWorkbookSet
 
instance.EndUpdate()

void EndUpdate()

procedure EndUpdate();

function EndUpdate();

void EndUpdate();

void EndUpdate();

Remarks

This method is thread safe.

EndUpdate releases the lock which was acquired by BeginUpdate by calling GetLock.

See GetLock and ReleaseLock for more information about acquiring and releasing locks and the effect this has on background calculation.

Example

Demonstrate using a workbook set in a thread safe manner when accessing the SpreadsheetGear API many times.

void DoSomeThreadSafeWorkQuickly(IWorkbookSet workbookSet)
        {
            // Interrupt background calculation if necessary, acquire an
            // exclusive lock on the workbook set and suspend events and
            // painting.
            workbookSet.BeginUpdate();
 
            try {
                // Do a lot of work...
            }
            finally {
                // Release the lock on the workbook set, start background
                // calculation if appropriate and repaint controls.
                workbookSet.EndUpdate();
            }
        }

Visual Basic

Sub DoSomeThreadSafeWorkQuickly(ByVal workbookSet As IWorkbookSet)
            ' Interrupt background calculation if necessary, acquire an 
            ' exclusive lock on the workbook set and suspend events and
            ' painting.
            workbookSet.BeginUpdate()
 
            Try
                ' Do a lot of work... 
            Finally
                ' Release the lock on the workbook set, start background 
                ' calculation if appropriate and repaint controls.
                workbookSet.EndUpdate()
            End Try
        End Sub 'DoSomeThreadSafeWork

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IWorkbookSet Interface
IWorkbookSet Members
BeginUpdate Method
GetLock Method
ReleaseLock Method