Partager via

Pages de paramètres de configuration du convertisseur personnalisé

  • Article

Si votre convertisseur de documents personnalisé nécessite une interface de configuration personnalisée, vous pouvez créer et spécifier une page .aspx personnalisée dans ce but. Cette page remplace alors la page des paramètres de configuration des documents par défaut intégrée dans Microsoft Office SharePoint Server 2007.

Notes

Si vous devez collecter des informations complémentaires auprès de l'administrateur, uniquement au cours de la configuration, vous pouvez spécifier un contrôle .ascx personnalisé à héberger dans la page de paramètres de configuration de document par défaut, incluse dans Office SharePoint Server 2007. Cela permet d'utiliser la page de paramètres de configuration du convertisseur de documents par défaut, au lieu de créer un formulaire de remplacement. Pour plus d'informations, voir Autres contrôles de paramètres de convertisseur.

Les administrateurs peuvent utiliser votre page personnalisée pour spécifier les paramètres de configuration pour chaque type de contenu utilisant le convertisseur. Les paramètres de convertisseur spécifiques à un type de contenu sont passés au convertisseur de documents lorsque l'utilisateur choisit de convertir un document de ce type. La page de paramètres de configuration du convertisseur par défaut, qui est incluse dans Office SharePoint Server 2007, contient un code qui passe les paramètres de convertisseur spécifiques à un type de contenu.

Pour spécifier une page de paramètres de configuration du convertisseur, affectez à l'élément ConverterSettingsForContentType de la définition du convertisseur de documents le nom de fichier de la page .aspx à utiliser. Il s'agit d'un élément facultatif. Si vous ne l'incluez pas dans votre définition de convertisseur, aucune page de configuration de convertisseur ne sera disponible pour ce convertisseur.

Pour plus d'informations sur la définition du convertisseur de documents, voir Schéma de définition du convertisseur de documents.

Office SharePoint Server 2007 transmet les informations suivantes à la page de paramètres de configuration du convertisseur lorsqu'un utilisateur la consulte :

  • ctype   Représente l'ID du type de contenu pour lequel l'utilisateur souhaite configurer ce convertisseur.

  • Converter   Représente le GUID du convertisseur que l'utilisateur souhaite configurer.

  • OriginalSource   Représente l'URL de la page à partir de laquelle l'utilisateur a commencé la navigation. Ce paramètre n'est pas utilisé dans ce contexte et peut être ignoré.

    Exemple :

    http://example-ts/_layouts/ConverterSettings.aspx?ctype=0x0101&Converter=6dfdc5b4%2D2a28%2D4a06%2Db0c6%2Dad3901e3a807&OriginalSource=http%3A%2F%2Fexample%2Dts%2FDocuments%2FForms%2FAllItems%2Easpx

    La page que vous spécifiez doit contenir le code qui permet les opérations suivantes :

    1. Formater les paramètres de configuration collectés par la page dans un document XML.

      Pour que le convertisseur puisse fournir les informations de configuration nécessaires au post-traitement de la conversion du document, il doit stocker ses paramètres de configuration dans le type de contenu spécifié, en fonction du schéma suivant.

      <rca:RCAuthoringProperties xmlns:rca="urn:sharePointPublishingRcaProperties">
  <rca:Converter rca:guid="6dfdc5b4-2a28-4a06-b0c6-ad3901e3a807">
    <rca:property rca:type="InheritParentSettings">True</rca:property>
    <rca:property rca:type="SelectedPageLayout">30</rca:property>
    <rca:property rca:type="SelectedPageField">f55c4d88-1f2e-4ad9-
      aaa8-819af4ee7ee8</rca:property>
    <rca:property rca:type="SelectedStylesField">a932ec3f-94c1-48b1-
      b6dc-41aaa6eb7e54</rca:property>
    <rca:property 
      rca:type="CreatePageWithSourceDocument">True</rca:property>
    <rca:property 
      rca:type="AllowChangeLocationConfig">True</rca:property>
    <rca:property rca:type="ConfiguredPageLocation"></rca:property>
    <rca:property rca:type="CreateSynchronously">True</rca:property>
    <rca:property 
      rca:type="AllowChangeProcessingConfig">True</rca:property>
    <rca:property rca:type="ConverterSpecificSettings"></rca:property>
  </rca:Converter>
</rca:RCAuthoringProperties>

      Dans l'exemple précédent, les éléments représentent les différentes options disponibles dans la page des paramètres de configuration du convertisseur par défaut. L'élément ConverterSpecificSettings représente les paramètres de configuration écrits par le contrôle .ascx spécifique au convertisseur, s'il en existe un. Pour plus d'informations, voir Autres contrôles de paramètres de convertisseur. Par ailleurs, l'élément ConfiguredPageLocation est vide, pour indiquer qu'Office SharePoint Server 2007 doit utiliser le site actif.

    2. Écrire cette configuration XML dans la définition du type de contenu adéquat sous forme de nœud XMLDocument.

      Par exemple, le code qui suit permet de mettre à jour la définition du type de contenu du site, après avoir construit le document XML approprié, comme indiqué précédemment :

      // Delete the previous instance of this document if it already exists.
myContentType.XmlDocuments.Delete(RcaPropertiesNamespaceUri);
myContentType.XmlDocuments.Add(this.myXmlDocument);
myContentType.Update();

Les données des paramètres de configuration peuvent correspondre à n'importe quel XML bien formé que le convertisseur de documents peut analyser. Office SharePoint Server 2007 n'analyse pas les informations lui-même mais permet simplement de stocker ce XML dans la définition du type de contenu, afin de le transmettre ultérieurement au convertisseur de documents.

Notez que si vous spécifiez une page de paramètres de configuration de convertisseur, vous devez également spécifier une page .aspx personnalisée pour l'interface utilisateur, afin de pouvoir invoquer ce convertisseur de documents. La page par défaut pour l'invocation des conversions de documents ne passe aucun paramètre de configuration aux convertisseurs sélectionnés. Pour plus d'informations, voir Pages de paramètres de conversion personnalisées.

Hébergement d'un contrôle de paramètres de convertisseur personnalisé

Pour activer les contrôles de paramètres de convertisseur personnalisé, la page qui invoque le convertisseur de documents doit contenir le code qui permet cette activation.

Par exemple, le code qui suit, placé dans la fonction OnLoad de la page, permet d'ajouter un contrôle de paramètres de convertisseur personnalisé dans la page, si un contrôle personnalisé est spécifié.

L'exemple qui suit nécessite deux membres dans le fichier code-behind :

  • Un membre nommé customControl du type System.Web.UI.Control

  • Un membre nommé customConverterControl du type System.Web.UI.WebControls.PlaceHolder, ainsi qu'un espace réservé correspondant dans la page .aspx

    if (!String.IsNullOrEmpty(myTransformer.ConverterSpecificSettingsUI))
{
  this.customControl = 
    LoadControl(myTransformer.ConverterSpecificSettingsUI);
  this.customConverterControl = this.customControl as 
    IDocumentConverterControl;
  if (this.customConverterControl != null)
  {
    this.converterSpecificControl.Controls.Add(this.customControl);
  }
}

    Ensuite, le code applique les paramètres existants du contrôle de paramètres du convertisseur personnalisé.

    // Set up the converter-specific control and retrieve the settings.
if (this.customConverterControl != null)
{
  this.customConverterControl.ContentType = this.CurrentContentType;
  this.customConverterControl.ConverterSettings = 
      this.effectiveRcaProperties.ConverterSpecificSettings; 
}

    Enfin, le code exemple qui suit, placé dans la fonction OnOK de la page, conserve les paramètres du convertisseur personnalisé dans la définition du type de contenu du site. Notez que le code définit le type de contenu afin de fournir au contrôle des informations contextuelles supplémentaires.

    // Persist the converter-specific settings.
if (this.converterSpecificControl.Controls.Count > 0)
{
  if (this.customConverterControl != null)
  {
    this.customConverterControl.ContentType = this.CurrentContentType;
    this.myRcaProperties.ConverterSpecificSettings =       this.customConverterControl.ConverterSettings; 
// Store this string in the content type properties as converter specific settings.
  }
}

Configuration requise pour le convertisseur

Il est recommandé d'inclure un code qui détermine si le convertisseur nécessite une configuration et si oui, d'afficher le message d'erreur adéquat. Ce code peut varier grandement en fonction de l'implémentation de la page.

Voir aussi

Autres ressources

Vue d'ensemble des convertisseurs de documents
Convertisseurs de documents
Déploiement de conversion de document
Schéma de définition du convertisseur de documents
Autres contrôles de paramètres de convertisseur
Pages de paramètres de conversion personnalisées