DocumentConverter Element (Document Converter)

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Specifies the definition of a document converter.

Definition

<DocumentConverter
  Id="Text"
  Name="Text"
  App="Text"
  From="Text"
  To="Text"
  ConverterUIPage="Text"
  ConverterSpecificSettingsUI="Text"
  ConverterSettingsForContentType="Text"
/>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute

Description

**Id**

Optional **Text**. Specifies the globally unique identifier (GUID) for this document converter.

**Name**

Optional **Text**. Specifies the document converter name.

**App**

Optional **Text**. Specifies the short name of the document converter executable file.

**From**

Optional **Text**. Specifies the file name extension of the original file to be passed to the document converter. Do not start the file extension with a period.

**To**

Optional **Text**. Specifies the file name extension of the converted copy that the document converter produces. Do not start the file name extension with a period.

**ConverterUIPage**

Optional **Text**. Specifies the file name of the .aspx page to display to users to specify conversion options for the selected document.

**ConverterSpecificSettingsUI**

Optional **Text**. Specifies the file name of an .ascx control to host on an existing converter configuration page. Use the control to add configuration options to the existing page.

**ConverterSettingsForContentType**

Optional **Text**. Specifies the file name of the .aspx page to display to enable administrators to set configuration settings for this converter, per site content type.

Child elements

None.

Parent elements

Elements Element (Document Converter)

Example

The following example is the document converter definition file for a custom document converter that converts files of File Type A format to File Type B format.

    <?xml version="1.0" encoding="utf-8" ?>
    <Elements xmlns="http://schemas.microsoft.com/sharepoint/">
      <DocumentConverter ID="{3f8ae156-93dc-46de-bcb3-0a89416a20b3}"
        Name="FileTypeA to FileTypeB"
        App="FTA2FTB.exe"
        From="fta"
        To="ftb"
        ConverterUIPage="FTA2FTB.aspx"
        ConverterSpecificSettingsUI="FTA2FTBConfig.aspx"
        ConverterSettingsForContentType="FTA2FTBConfig.ascx"
      />
    </Elements>

See also