SPFile.Convert - Méthode

Article
05/12/2015

Remarque : cette API est désormais obsolète.

Transforme le fichier en utilisant le transformateur spécifié.

Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
<ObsoleteAttribute("This member is obsolete - use the specialized Office services instead",  _
    False)> _
Public Function Convert ( _
    ConverterId As Guid, _
    newFileName As String, _
    configInfo As String, _
    handlerAssembly As String, _
    handlerClass As String, _
    priority As Byte, _
    peopleToAlert As String, _
    sendACopy As Boolean, _
    synchronous As Boolean, _
    <OutAttribute> ByRef workItemId As Guid _
) As SPFileConversionResult
'Utilisation
Dim instance As SPFile
Dim ConverterId As Guid
Dim newFileName As String
Dim configInfo As String
Dim handlerAssembly As String
Dim handlerClass As String
Dim priority As Byte
Dim peopleToAlert As String
Dim sendACopy As Boolean
Dim synchronous As Boolean
Dim workItemId As Guid
Dim returnValue As SPFileConversionResult

returnValue = instance.Convert(ConverterId, _
    newFileName, configInfo, handlerAssembly, _
    handlerClass, priority, peopleToAlert, _
    sendACopy, synchronous, workItemId)

[ObsoleteAttribute("This member is obsolete - use the specialized Office services instead", 
    false)]
public SPFileConversionResult Convert(
    Guid ConverterId,
    string newFileName,
    string configInfo,
    string handlerAssembly,
    string handlerClass,
    byte priority,
    string peopleToAlert,
    bool sendACopy,
    bool synchronous,
    out Guid workItemId
)

Paramètres

ConverterId
Type : System.Guid

Un objet System.Guid qui identifie le transformateur de document spécifique à utiliser pour transformer le document.

newFileName
Type : System.String

Chaîne qui contient le nom de feuille du fichier à créer. L'extension est automatiquement ajoutée par le transformateur.

configInfo
Type : System.String

Chaîne qui contient les informations de configuration qui sont transmises à l'application de transformation lorsque cette transformation est demandée. Les informations sont spécifiques à l'application de la transformation et peuvent être une chaîne vide ou une référence null (Nothing dans Visual Basic).

handlerAssembly
Type : System.String

Facultatif. Chaîne qui spécifie un assembly à charger. Avec le paramètre handlerClass , vous pouvez spécifier un gestionnaire de conversion avant ou après conversion à appeler avant ou après la conversion à effectuer différentes tâches avec le contenu converti, plutôt que simplement la structure de conversion rendent dans un fichier. La valeur de ce paramètre peut être une référence Null (Rien dans Visual Basic).

handlerClass
Type : System.String

Facultatif. Chaîne qui spécifie une classe qui est définie dans l'assembly spécifié par le paramètre handlerAssembly pour instancier. La classe doit implémenter l'interface ISPConversionProcessor et ses méthodes. Avec le paramètre handlerAssembly , vous pouvez spécifier un gestionnaire de conversion avant ou après conversion à appeler avant ou après la conversion à effectuer différentes tâches avec le contenu converti, plutôt que simplement la structure de conversion rendent dans un fichier. La valeur de ce paramètre peut être une référence null (Nothing dans Visual Basic).

priority
Type : System.Byte

La priorité de cette transformation. Inférieur

priorité signifie que cette transformation sera traitée plus rapidement. Les transformations sont initiées via l'interface utilisateur ont une priorité de 1. Opérations en bloc qui sont effectuées par le biais de script personnalisé doivent avoir une priorité plus faible.

peopleToAlert
Type : System.String

Une liste délimitée par des points-virgules d'adresses de messagerie des personnes à qui envoyer une alerte lorsque la transformation est terminée. Si la chaîne est vide ou une référence Null (Rien dans Visual Basic), aucune alerte n'est envoyée.

sendACopy
Type : System.Boolean

true à joindre une copie du document transformé à la notification ; dans le cas contraire, false.

synchronous
Type : System.Boolean

true pour exécuter la conversion de façon synchrone ; dans le cas contraire, false.

workItemId
Type : System.Guid

Un paramètre out qui obtient l'ID de la

élément de travail à cette demande asynchrone ou qui obtient Guid.Empty dans le cas d'une demande synchrone.

Valeur renvoyée

Type : Microsoft.SharePoint.SPFileConversionResult
Une valeur SPFileConversionResult qui indique l'état de la conversion.

Voir aussi

Référence

SPFile classe

SPFile - Membres

Microsoft.SharePoint - Espace de noms

ISPConversionProcessor

Share via