DocumentBase.CheckIn(Boolean, Object, Boolean) 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
将本地计算机上的文档放在服务器上,并将本地文档设置为只读,以便它不能在本地编辑。
public void CheckIn(bool saveChanges, ref object comments, bool makePublic);
member this.CheckIn : bool * obj * bool -> unit
Public Sub CheckIn (Optional saveChanges As Boolean, Optional ByRef comments As Object, Optional makePublic As Boolean)
参数
- saveChanges
- Boolean
如果为 true,则会将文档保存到服务器位置。 默认为 true。
- comments
- Object
仅当 SaveChanges 设置为 true) 时,才对签入的文档的修订 (注释适用。
- makePublic
- Boolean
如果为 true,则允许用户在文档签入后发布该文档。
示例
下面的代码示例使用 CanCheckin 方法确定文档是否已存储在 Microsoft SharePoint Portal Server 上。 如果文档已存储在服务器上,则示例调用 CheckIn 方法以在文档中检查,将更改保存到服务器位置,然后提交文档进行审批过程。 若要使用此示例,请从文档级项目中的 ThisDocument 类运行它。
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");
}
}
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
注解
makePublic将 参数设置为 true 将提交文档以进行审批过程,这最终可能导致将文档版本发布到对文档具有只读权限的用户, (仅当 设置为 true) 时saveChanges适用。
若要利用内置于 Word 中的协作功能,文档必须存储在 Microsoft SharePoint Portal Server 上。
可选参数
有关可选参数的信息,请参阅 Office 解决方案中的可选参数。