文档转换器对象模型

上次修改时间: 2010年3月8日

适用范围: SharePoint Server 2010

该 SharePoint Foundation 对象模型中包含的成员可表示指定 Web 应用程序中的文档转换器,以及给定文档库中转换后的副本。

文档转换器的对象模型成员

您可以通过使用 Microsoft.SharePoint.Administration 命名空间的以下成员,以编程方式配置给定 Web 应用程序中的文档转换器:

  • DocumentConverters   返回一个 SPDocumentConverterCollection 对象,该对象表示当前为 Web 应用程序安装的文档转换器。

  • DocumentConversionsEnabled   获取或设置是否为 Web 应用程序启用文档转换器。

  • DocumentConversionsLoadBalancerUrl   获取或设置为 Web 应用程序运行 DocConvLoadBalancer 服务的服务器的 URI。

  • DocumentConversionsSchedule   获取或设置文档转换器计划。

  • SPDocumentConverterCollection   表示当前为 Web 应用程序安装的文档转换器。

  • SPDocumentConverter   表示当前为 Web 应用程序安装的单个文档转换器。此对象包含用于表示文档转换器定义架构中定义的转换器设置的只读属性,如转换器名称、程序集名称、"to"和"from"文件扩展名和转换器用户界面页。此外,每个 SPDocumentConverter 实例还包括管理员在 Web 应用程序级别设置的转换器设置。这些特定于 Web 应用程序的设置包括:是否在最终用户的用户界面中显示文档转换器、最多重试次数、转换文件的大小上限和超时时间长度。

    有关详细信息,请参阅文档转换器定义架构

转换后的文档的对象模型成员

通过使用以下 SPFile 对象成员,您可以以编程方式识别和处理原始文件及其转换后的副本:

  • Convert   此方法使用指定的文档转换器创建指定文档的转换后副本。您可以指定要传递给文档转换器的自定义配置信息、转换后副本的文件名、转换优先级、要向其发送通知的用户的电子邮件地址,以及是否将转换后的副本作为附件添加到通知邮件。若要让自定义程序集(而不是 Microsoft SharePoint Server 2010)对转换后的副本执行后续处理,您可以指定一个自定义处理程序程序集和类。若不指定自定义处理程序,SharePoint Server 2010 将对转换后的副本执行常规的后续处理。

    有关自定义处理的详细信息,请参阅已转换文档的自定义处理

    有关 SharePoint Server 2010 默认执行的后续处理的详细信息,请参阅转换后的文档。返回类型 SPFileConversionResult 将指示文档转换的结果。

  • GetConvertedFile   返回由指定文档转换器从此文件生成的转换后副本。如果没有由指定转换器生成的转换后副本,则返回 null。

  • GetConversionState   返回一个 SPFileConversionState 枚举,该枚举表示使用指定文档转换器进行转换的状态。您可以调用此方法以确定使用此文档转换器进行转换的可能性。SPFileConversionState 枚举包括以下值:

    • Available   本系统支持使用指定的文档转换器转换此文件。

    • Completed   使用指定文档转换器对此文件进行的转换尚未完成。

    • NotAvailable   本系统不支持使用指定的文档转换器转换此文件。

    • Pending   已请求使用指定的文档转换器转换此文件,但转换尚未完成。

  • IsConvertedFile  若该文件是另一文档的转换后副本,则返回 true。

  • SPFile.ParentFile   返回一个 SPFile 对象,该对象表示用来创建此转换后副本的原始文档。若所选文件不是转换后的副本,则返回 null。

  • GeneratingConverterId   返回用来创建此转换后副本的文档转换器的 GUID。若所选文件不是转换后的副本,则返回 null。

  • Generator   返回用来创建此转换后副本的文档转换器的名称。

请参阅

概念

文档转换器概述

文档转换器