Modèle objet pour les convertisseurs de documents
Dernière modification : lundi 8 mars 2010
S’applique à : SharePoint Server 2010
Le modèle objet SharePoint Foundation contient des membres qui représentent les convertisseurs de documents dans une application Web spécifiée, ainsi que les copies converties dans une bibliothèque de documents donnée.
Membres du modèle objet pour les convertisseurs de documents
Vous pouvez configurer par programme les convertisseurs de documents d'une application Web donnée à l'aide des membres suivants de l'espace de noms Microsoft.SharePoint.Administration :
DocumentConverters Retourne un objet SPDocumentConverterCollection qui représente les convertisseurs de documents actuellement installés pour l'application Web.
DocumentConversionsEnabled Obtient ou définit les convertisseurs de documents à activer pour l'application Web.
DocumentConversionsLoadBalancerUrl Obtient ou définit l'URI du serveur qui exécute le service DocConvLoadBalancerde l'application Web.
DocumentConversionsSchedule Obtient ou définit la planification du convertisseur de documents.
SPDocumentConverterCollection Représente les convertisseurs de documents actuellement installés pour l'application Web.
SPDocumentConverter Représente un seul convertisseur de documents actuellement installé pour l'application Web. Cet objet contient des propriétés en lecture seule qui représentent les paramètres du convertisseur définis dans le schéma de définition du convertisseur de documents, tels que le nom du convertisseur, le nom de l'assembly, les extensions de nom de fichier « départ » et « arrivée » et les pages d'interface utilisateur du convertisseur. En outre, chaque instance d'objet SPDocumentConverter comporte les paramètres du convertisseur qui sont définis par l'administrateur au niveau de l'application Web. Ces paramètres propres à l'application Web spécifient si le convertisseur de documents doit être affiché dans l'interface utilisateur et indiquent le nombre maximal de nouvelles tentatives, la taille de fichier maximale pour les conversions et le délai d'expiration.
Pour plus d'informations, voir Schéma de définition du convertisseur de documents.
Membres du modèle objet pour les documents convertis
Vous pouvez identifier les fichiers d'origine et les copies converties et les utiliser par programme à l'aide des membres suivants de l'objet SPFile :
Convert Cette méthode crée une copie convertie du document spécifié à l'aide du convertisseur de documents indiqué. Vous pouvez également spécifier les informations de configuration personnalisées à transmettre au convertisseur de documents : nom de fichier de la copie convertie, priorité de la conversion, adresses de messagerie des utilisateurs à informer et ajout ou non de la copie convertie sous forme de pièce attachée dans les messages d'alerte. Pour qu'un assembly personnalisé effectue un post-traitement de la copie convertie (et non Microsoft SharePoint Server 2010), vous pouvez spécifier un assembly gestionnaire et une classe gestionnaire personnalisés. Si vous ne spécifiez aucun gestionnaire personnalisé, SharePoint Server 2010 effectue le post-traitement de la copie convertie.
Pour plus d'informations sur le traitement personnalisé, voir Traitement personnalisé des documents convertis.
Pour plus d'informations sur le post-traitement effectué par défaut par SharePoint Server 2010, voir Documents convertis. Le type de retour, SPFileConversionResult, indique le résultat de la conversion du document.
GetConvertedFile Retourne la copie convertie de ce fichier qui a été générée par le convertisseur de documents spécifié. Retourne la valeur null s'il n'existe aucune copie convertie générée.
GetConversionState Retourne une énumération SPFileConversionState qui représente l'état d'une conversion effectuée à l'aide du convertisseur de documents spécifié. Vous pouvez appeler cette méthode pour déterminer s'il est possible d'effectuer une conversion à l'aide de ce convertisseur de documents. Les valeurs de l'énumération SPFileConversionState sont les suivantes :
Available La conversion de ce fichier à l'aide du convertisseur de documents spécifié est prise en charge sur ce système.
Completed Une conversion de ce fichier à l'aide du convertisseur de documents spécifié n'est pas terminée.
NotAvailable Une conversion de ce fichier à l'aide du convertisseur de documents spécifié n'est pas prise en charge sur ce système.
Pending Une conversion de ce fichier à l'aide du convertisseur de documents spécifié a été demandée, mais n'est pas encore terminée.
IsConvertedFile Retourne la valeur true si le fichier est une copie convertie d'un autre document.
SPFile.ParentFile Retourne un objet SPFile qui représente le document d'origine qui a été utilisé pour créer cette copie convertie. Retourne la valeur null si le fichier sélectionné n'est pas une copie convertie.
GeneratingConverterId Retourne le GUID du convertisseur de documents qui a été utilisé pour créer cette copie convertie. Retourne la valeur null si le fichier sélectionné n'est pas une copie convertie.
Generator Retourne le nom du convertisseur de documents qui a été utilisé pour créer cette copie convertie.