This documentation is archived and is not being maintained.

Workbook.CheckIn Method

Gets a workbook from a local computer to a server, and sets the local workbook to read-only so that it cannot be edited locally. Calling this method closes the workbook.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in microsoft.office.tools.excel.dll)

public virtual void CheckIn (
	[OptionalAttribute] Object SaveChanges,
	[OptionalAttribute] Object Comments,
	[OptionalAttribute] Object MakePublic
)

Parameters

SaveChanges

true saves changes and checks in the document; false returns the document to a checked-in status without saving revisions.

Comments

Allows the user to enter check-in comments for the revision of the workbook being checked in (applies only if SaveChanges equals true).

MakePublic

true allows the user to publish the workbook after it has been checked in. This submits the workbook for the approval process, which can eventually result in a version of the workbook being published to users with read-only rights to the workbook (applies only if SaveChanges equals true).

Optional Parameters

For information on optional parameters, see Understanding Optional Parameters in COM Interop.

The following code example uses the CanCheckIn method to determine whether Microsoft Office Excel can check in the current workbook to a server. If the workbook can be checked in, then the example uses the CheckIn method to save revisions and check in the current workbook.

private void WorkbookCheckIn()
{
    // Determine if workbook can be checked in.
    if (this.CanCheckIn())
    {
        this.CheckIn(true, "Updates.", true);
        MessageBox.Show(this.Name + " was checked in.");
    }
    else
    {
        MessageBox.Show(this.Name + " cannot be checked in.");
    }
}

Show: