SPFile.Convert-Methode

HINWEIS: Diese API ist veraltet.

Die Datei mit der angegebenen Transformator transformiert.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<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
'Usage
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
)

Parameter

• ConverterId
  Typ: System.Guid

  Ein System.Guid -Objekt, das bestimmten Beleg ein Transformator zum Transformieren des Dokuments identifiziert.

• newFileName
  Typ: System.String

  Eine Zeichenfolge, die mit dem Namen Blatt der Datei erstellt werden soll. Die Erweiterung wird automatisch vom Transformator angefügt.

• configInfo
  Typ: System.String

  Eine Zeichenfolge, die die Konfigurationsinformationen enthält, die für die Anwendung der Transformation übergeben wird, wenn diese Transformation angefordert wird. Die Informationen ist spezifisch für die Anwendung der Transformation und kann eine leere Zeichenfolge oder ein null-Verweis (Nothing in Visual Basic) sein.

• handlerAssembly
  Typ: System.String

  Optional. Eine Zeichenfolge, die eine zu ladende Assembly angibt. Zusammen mit dem handlerClass -Parameter können Sie angeben, eine vor der Konvertierung oder nach der Konvertierung-Handler aufrufen, vor oder nach der Konvertierung in andere Aufgaben mit den konvertierten Inhalt, statt nur Konvertierung Rahmen in einer Datei zu erleichtern. Der Wert dieses Parameters kann ein Nullverweis (Nothing in Visual Basic)sein.

• handlerClass
  Typ: System.String

  Optional. Eine Zeichenfolge, die eine Klasse instanziieren, die in der durch den handlerAssembly -Parameter angegebenen Assembly definiert ist. Die Klasse muss die ISPConversionProcessor -Schnittstelle und die zugehörigen Methoden implementieren. Zusammen mit dem handlerAssembly -Parameter können Sie angeben, eine vor der Konvertierung oder nach der Konvertierung-Handler aufrufen, vor oder nach der Konvertierung in andere Aufgaben mit den konvertierten Inhalt, statt nur Konvertierung Rahmen in einer Datei zu erleichtern. Der Wert dieses Parameters kann ein null-Verweis (Nothing in Visual Basic) sein.

• priority
  Typ: System.Byte

  Die Priorität für diese Transformation. Eine niedrigere

  Priorität bedeutet, dass diese Transformation schneller verarbeitet werden. Transformationen, die über die Benutzeroberfläche gestartet werden, haben eine Priorität von 1. Bulk-Vorgänge, die über ein benutzerdefiniertes Skript ausgeführt werden, sollten eine niedrigere Priorität haben.

• peopleToAlert
  Typ: System.String

  Eine durch Semikolons getrennte Liste mit e-Mail-Adressen der Personen, an die eine Warnung zu senden, wenn die Transformation abgeschlossen ist. Wenn die Zeichenfolge leer oder ein Nullverweis (Nothing in Visual Basic)ist, wird keine Warnung gesendet.

• sendACopy
  Typ: System.Boolean

  true können Sie die Benachrichtigung eine Kopie des transformierten Dokuments zuordnen; andernfalls false.

• synchronous
  Typ: System.Boolean

  true eine synchrone Ausführung die Konvertierung; andernfalls false.

• workItemId
  Typ: System.Guid

  Ein out -Parameter, der die ID des Ruft die

  Arbeitsaufgabe für diese asynchrone Anforderung oder, ruft Guid.Empty bei einer synchronen Anforderung ab.

Rückgabewert

Typ: Microsoft.SharePoint.SPFileConversionResult
Ein SPFileConversionResult -Wert, der den Konvertierungsstatus angibt.

Siehe auch

Referenz

SPFile Klasse

SPFile-Member

Microsoft.SharePoint-Namespace

ISPConversionProcessor