Share via


DocumentBase.CanCheckin Method

Determines whether Microsoft Office Word can check in the document to a server.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
Public Function CanCheckin As Boolean
public bool CanCheckin()

Return Value

Type: System.Boolean
true if Microsoft Office Word can check in the document to a server; otherwise, false.

Remarks

To take advantage of the collaboration features built into Word, documents must be stored on a Microsoft SharePoint Portal Server.

Examples

The following code example uses the CanCheckin method to determine whether the document has been stored on a Microsoft SharePoint Portal Server. If the document has been stored on a server, then the example calls the CheckIn method to check in the document, save changes to the server ___location, and submit the document for the approval process. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub DocumentCheckIn()
    If CanCheckin() = True Then
        Me.CheckIn(True, "My updates.", True)
    Else
        MessageBox.Show("This document cannot be checked in")
    End If
End Sub
private void DocumentCheckIn()
{
    if (this.CanCheckin())
    {
        object comments = "My updates.";
        this.CheckIn(true, ref comments, true);
    }
    else
    {
        MessageBox.Show("This document cannot be checked in");
    }
}

.NET Framework Security

See Also

Reference

DocumentBase Class

Microsoft.Office.Tools.Word Namespace