DocumentBase.CheckIn, méthode

Article
05/16/2013

Place un document sur un serveur depuis un ordinateur local, et définit le document local en lecture seule de sorte qu'il ne puisse pas être modifié localement.

Espace de noms : Microsoft.Office.Tools.Word
Assembly : Microsoft.Office.Tools.Word.v4.0.Utilities (dans Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntaxe

'Déclaration
Public Sub CheckIn ( _
    saveChanges As Boolean, _
    ByRef comments As Object, _
    makePublic As Boolean _
)

public void CheckIn(
    bool saveChanges,
    ref Object comments,
    bool makePublic
)

Paramètres

saveChanges
Type : System.Boolean
true pour enregistrer le document à l'emplacement du serveur.La valeur par défaut est true.

comments
Type : System.Object%
Commentaires pour la révision du document en cours d'archivage (s'applique uniquement si SaveChanges a la valeur true).

makePublic
Type : System.Boolean
true pour permettre à l'utilisateur de publier le document après son archivage.

Notes

Affecter la valeur true au paramètre makePublic soumet le document au processus d'approbation, ce qui peut éventuellement entraîner la publication d'une version du document pour des utilisateurs disposant de droits en lecture seule sur le document (s'applique uniquement si saveChanges a la valeur true).

Pour tirer parti des fonctionnalités de collaboration intégrées de Word, les documents doivent être stockés sur un serveur Microsoft SharePoint Portal Server.

Paramètres optionnels

Pour plus d'informations sur les paramètres optionnels, consultez Paramètres optionnels dans les solutions Office.

Exemples

L'exemple de code suivant utilise la méthode CanCheckin pour déterminer si le document a été stocké sur un serveur Microsoft SharePoint Portal Server.Si le document a été stocké sur un serveur, l'exemple appelle la méthode CheckIn pour archiver le document, enregistrer les modifications à l'emplacement du serveur et soumettre le document au processus d'approbation.Pour utiliser cet exemple, exécutez-le à partir de la classe ThisDocument dans un projet au niveau du document.

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");
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

DocumentBase Classe

Microsoft.Office.Tools.Word, espace de noms

Partager via