Share via

Custom Conversion Settings Pages in SharePoint Server 2010 (ECM)

  • Article

Applies to: SharePoint Server 2010

You can designate a custom .aspx page from which the user can specify settings for a particular conversion of the selected document, or use the default conversion settings page included in Microsoft SharePoint Foundation.

To specify a custom conversion settings page, set the ConverterUIPage element of the document converter definition to the file name of your custom aspx page. This becomes the page that is displayed when the user selects to convert a document using your converter. Setting the ConverterUIPage element is optional. If you do not specify a custom page, Microsoft SharePoint Server 2010 displays the default page, DocTrans.aspx.

DocTrans.aspx lets the user select which converters to use. Only document converters that use the DocTrans.aspx page are displayed on the page. It also enables users to specify file names for each converted file, as well as whether the user wants to be notified when the conversions are completed. When submitted, the page calls the Convert method once for each selected converter, passing the necessary parameters.

The DocTrans.aspx page specifies that each conversion be run asynchronously.

If you create a custom conversion settings page, you are responsible for including code that calls the Convert method, passing whatever parameters are appropriate. In the case of a converter that includes custom configuration settings, the page must include code that does the following:

  • Determines the content type of the document to be converted.

  • Accesses the content type definition, and retrieves the XMLDocument node containing the converter configuration settings for that content type.

  • Passes those converter configuration settings to the Convert method as the configInfo parameter.

    Note

    If you are creating a document converter for publishing Web content, you should call the PublishingPageCollection.Add method, instead of the Convert method. The PublishingPageCollection.Add method provides specialized post-processing that includes creating a new Web page and placing the HTML generated by the converter into the specified fields on that page. For more information about document converters for publishing Web content, see Page Publishing Using SharePoint Document Converters (ECM).

You should be aware that the DocTrans.aspx page does not do the following:

  • Pass any configuration data to the Convert method. If you create a document converter that includes custom configuration settings, do not use the DocTrans.aspx page, as these settings are not passed to the document converter. Instead, create a custom conversion settings page and specify it in the document converter definition.

  • Specify any custom pre-processing or post-processing of the converted file. For more information about specifying custom pre-processing or post-processing, see Custom Processing of Converted Documents in SharePoint Server 2010 (ECM).

See Also

Concepts

SharePoint Server 2010 Document Converter Development Overview (ECM)

Document Converters in SharePoint Server 2010 (ECM)

Document Converter Deployment in SharePoint Server 2010 (ECM)

Document Converter Definition Schema in SharePoint Server 2010 (ECM)

Custom Converter Configuration Settings Pages in SharePoint Server 2010 (ECM)

Additional Converter Settings Controls in SharePoint Server 2010 (ECM)