DocumentBase.CheckInWithVersion - метод

Статья
01/10/2014

Возвращает документ с локального компьютера на сервер и задает режим "только для чтения" для локального документа, чтобы сделать его недоступным для редактирования на локальном компьютере.

Пространство имен: Microsoft.Office.Tools.Word
Сборка: Microsoft.Office.Tools.Word.v4.0.Utilities (в Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Синтаксис

'Декларация
Public Sub CheckInWithVersion ( _
    saveChanges As Boolean, _
    ByRef comments As Object, _
    makePublic As Boolean, _
    ByRef versionType As Object _
)

public void CheckInWithVersion(
    bool saveChanges,
    ref Object comments,
    bool makePublic,
    ref Object versionType
)

Параметры

saveChanges
Тип: System.Boolean
true используется для сохранения документа на сервере.Значение по умолчанию — true.

comments
Тип: System.Object%
Примечания по проверке для редакции возвращаемого документа (применяется, только если параметру SaveChanges присвоено значение true).

makePublic
Тип: System.Boolean
true, чтобы разрешить пользователю опубликовать документ после проверки.

versionType
Тип: System.Object%
Указывает сведения о версии для документа.

Заметки

При значении true параметра MakePublic документ отправляется на утверждение, что может в конечном итоге привести к публикации версии документа для пользователей с правами доступа к документу «только чтение» (применяется, только если параметр SaveChanges имеет значение true).

Чтобы воспользоваться преимуществами встроенных в Word функций совместной работы, документы должны храниться на сервере Microsoft SharePoint Portal Server.

Необязательные параметры

Сведения о необязательных параметрах см. в разделе Необязательные параметры в решениях Office.

Примеры

В приведенном ниже примере кода метод CanCheckin используется, чтобы определить, был ли документ сохранен на сервере Microsoft Office SharePoint Portal Server. Если документ хранился на сервере, в примере вызывается метод CheckInWithVersion, чтобы вернуть документ с определенными комментариями и номером версии, сохранить изменения в местоположении сервера и отправить документ на утверждение. Чтобы использовать этот пример, запустите его из класса ThisDocument в проекте уровня документа.

Private Sub DocumentCheckIn()
    If Me.CanCheckin() Then
        Dim comments As Object = "My updates."
        Dim version As Object = _
            Word.WdCheckInVersionType.wdCheckInMinorVersion
        Me.CheckInWithVersion(True, comments, True, version)
    Else
        MessageBox.Show("This document cannot be checked in")
    End If
End Sub

private void DocumentCheckIn()
{
    if (this.CanCheckin())
    {
        object comments = "My updates.";
        object version = Word.WdCheckInVersionType.wdCheckInMinorVersion;
        this.CheckInWithVersion(true, ref comments, true, ref version);                
    }
    else
    {
        MessageBox.Show("This document cannot be checked in");
    }
}

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

DocumentBase Класс

Microsoft.Office.Tools.Word - пространство имен

Поделиться через