SPFile.Convert 方法
请注意:此 API 现在已过时。
转换的文件,使用指定的转换器。
命名空间: Microsoft.SharePoint
程序集: Microsoft.SharePoint(位于 Microsoft.SharePoint.dll 中)
语法
声明
<ObsoleteAttribute("This member is obsolete - use the specialized Office services instead", _
False)> _
Public Function Convert ( _
ConverterId As Guid, _
newFileName As String, _
configInfo As String, _
handlerAssembly As String, _
handlerClass As String, _
priority As Byte, _
peopleToAlert As String, _
sendACopy As Boolean, _
synchronous As Boolean, _
<OutAttribute> ByRef workItemId As Guid _
) As SPFileConversionResult
用法
Dim instance As SPFile
Dim ConverterId As Guid
Dim newFileName As String
Dim configInfo As String
Dim handlerAssembly As String
Dim handlerClass As String
Dim priority As Byte
Dim peopleToAlert As String
Dim sendACopy As Boolean
Dim synchronous As Boolean
Dim workItemId As Guid
Dim returnValue As SPFileConversionResult
returnValue = instance.Convert(ConverterId, _
newFileName, configInfo, handlerAssembly, _
handlerClass, priority, peopleToAlert, _
sendACopy, synchronous, workItemId)
[ObsoleteAttribute("This member is obsolete - use the specialized Office services instead",
false)]
public SPFileConversionResult Convert(
Guid ConverterId,
string newFileName,
string configInfo,
string handlerAssembly,
string handlerClass,
byte priority,
string peopleToAlert,
bool sendACopy,
bool synchronous,
out Guid workItemId
)
参数
ConverterId
类型:System.GuidSystem.Guid对象,该对象标识的特定文档转换器用于转换文档。
newFileName
类型:System.String一个字符串,包含要创建的文件的叶名称。通过转换器自动追加扩展名。
configInfo
类型:System.String一个字符串,包含在请求此转换时传递给该转换应用程序的配置信息。信息是特定于转换应用程序,也可以是空字符串或空引用 (在 Visual Basic 中的Nothing )。
handlerAssembly
类型:System.String可选。一个字符串,指定要加载的程序集。与handlerClass参数,您可以指定一个预转换或转换后的处理程序以调用之前或之后执行不同任务的转换的内容,而不只是使其到一个文件中的转换框架的转换。此参数的值可以是空引用(无 在 Visual Basic 中)。
handlerClass
类型:System.String可选。一个字符串,指定要实例化handlerAssembly参数所指定的程序集中定义的类。类必须实现ISPConversionProcessor接口和它的方法。与handlerAssembly参数,您可以指定一个预转换或转换后的处理程序以调用之前或之后执行不同任务的转换的内容,而不只是使其到一个文件中的转换框架的转换。此参数的值可以是空引用 (在 Visual Basic 中的Nothing )。
priority
类型:System.Byte此转换的优先级。较低的
优先级表示此转换将会更快地处理。通过用户界面启动的转换具有的优先级为 1。通过自定义脚本执行的批量操作应具有较低的优先级。
peopleToAlert
类型:System.String以分号分隔的收件人转换完成时发送警报的电子邮件地址列表。如果该字符串为空或空引用(无 在 Visual Basic 中),不发送任何警报。
sendACopy
类型:System.Booleantrue将转换后的文档的副本附加到该通知 ;否则为false。
synchronous
类型:System.Booleantrue同步 ; 运行转换否则为false。
workItemId
类型:System.Guid获取 ID 为out参数
工作项的此异步请求,或获取Guid.Empty在同步请求的情况下。
返回值
类型:Microsoft.SharePoint.SPFileConversionResult
一个SPFileConversionResult值,该值指示转换状态。