Compartilhar via

SPFile.Convert method

  • Artigo

NOTE: This API is now obsolete.

Transforma o arquivo usando o transformador especificado.

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

Syntax

'Declaração
<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
'Uso
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
)

Parâmetros

  • ConverterId
    Type: System.Guid

    Um objeto de System.Guid que identifica o transformador de documento específico a ser usado para transformar o documento.

  • newFileName
    Type: System.String

    Uma seqüência de caracteres que contém o nome de folha do arquivo a ser criado. A extensão é anexada automaticamente pelo transformador.

  • configInfo
    Type: System.String

    Uma seqüência de caracteres que contém as informações de configuração que são passadas para o aplicativo de transformação quando essa transformação é solicitada. As informações são específicas para o aplicativo de transformação e podem ser uma seqüência vazia ou uma referência nula (Nothing no Visual Basic).

  • handlerAssembly
    Type: System.String

    Opcional. Uma seqüência que especifica um assembly para carregar. Junto com o parâmetro handlerClass , você pode especificar um manipulador de conversão antes ou após a conversão para invocar antes ou após a conversão para executar diferentes tarefas com o conteúdo convertido, em vez de ter apenas a estrutura de conversão transformá-la em um arquivo. O valor deste parâmetro pode ser a null reference (Nothing in Visual Basic).

  • handlerClass
    Type: System.String

    Opcional. Uma seqüência de caracteres que especifica uma classe para criar uma instância que é definida no assembly especificado pelo parâmetro handlerAssembly . A classe deve implementar a interface ISPConversionProcessor e seus métodos. Junto com o parâmetro handlerAssembly , você pode especificar um manipulador de conversão antes ou após a conversão para invocar antes ou após a conversão para executar diferentes tarefas com o conteúdo convertido, em vez de ter apenas a estrutura de conversão transformá-la em um arquivo. O valor deste parâmetro pode ser uma referência nula (Nothing no Visual Basic).

  • priority
    Type: System.Byte

    A prioridade dessa transformação. Menos

    prioridade significa que essa transformação será processada mais rapidamente. Transformações são iniciadas por meio da interface de usuário possuem uma prioridade de 1. Operações em massa que são executadas por meio de script personalizado devem ter uma prioridade mais baixa.

  • peopleToAlert
    Type: System.String

    Uma lista delimitada por ponto e vírgula de endereços de email das pessoas a quem enviar um alerta quando a transformação estiver concluída. Se a seqüência for vazia ou a null reference (Nothing in Visual Basic), nenhum alerta será enviado.

  • sendACopy
    Type: System.Boolean

    true para anexar uma cópia do documento transformado a notificação; Caso contrário, false.

  • synchronous
    Type: System.Boolean

    true para executar a conversão de forma síncrona; Caso contrário, false.

  • workItemId
    Type: System.Guid

    Um parâmetro de out que obtém a ID das

    item de trabalho para essa solicitação assíncrona ou que obtém Guid.Empty no caso de uma solicitação síncrona.

Valor retornado

Type: Microsoft.SharePoint.SPFileConversionResult
Um valor de SPFileConversionResult que indica o status da conversão.

Ver também

Referência

SPFile class

SPFile members

Microsoft.SharePoint namespace

ISPConversionProcessor