del método SPFile.Convert

NOTA: esta API está ahora obsoleta.

Transforma el archivo mediante el transformador especificado.

Espacio de nombres:  Microsoft.SharePoint
Ensamblado:  Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
<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
  Tipo: System.Guid

  Un objeto System.Guid que identifica el transformador de documento específico a usar para transformar el documento.

• newFileName
  Tipo: System.String

  Una cadena que contiene el nombre de la hoja del archivo que se creará. La extensión se anexa automáticamente por el transformador.

• configInfo
  Tipo: System.String

  Una cadena que contiene la información de configuración que se pasa a la aplicación de transformación cuando se solicita esta transformación. La información es específica de la aplicación de transformación y puede ser una cadena vacía o una referencia nula (Nothing en Visual Basic).

• handlerAssembly
  Tipo: System.String

  Opcional. Una cadena que especifica un ensamblado que se va a cargar. Junto con el parámetro handlerClass , puede especificar un controlador de conversión previa o posterior a la conversión para invocar antes o después de la conversión a realizar tareas diferentes con el contenido convertido, en lugar de sólo tienen el marco de trabajo de conversión convertirlo en un archivo. El valor de este parámetro puede ser una referencia null (Nothing en Visual Basic).

• handlerClass
  Tipo: System.String

  Opcional. Una cadena que especifica una clase para crear una instancia que se define en el ensamblado especificado por el parámetro handlerAssembly . La clase debe implementar la interfaz ISPConversionProcessor y sus métodos. Junto con el parámetro handlerAssembly , puede especificar un controlador de conversión previa o posterior a la conversión para invocar antes o después de la conversión a realizar tareas diferentes con el contenido convertido, en lugar de sólo tienen el marco de trabajo de conversión convertirlo en un archivo. El valor de este parámetro puede ser una referencia nula (Nothing en Visual Basic).

• priority
  Tipo: System.Byte

  La prioridad de esta transformación. Un inferior

  prioridad significa que esta transformación se procesará con mayor rapidez. Transformaciones que se inician a través de la interfaz de usuario tienen una prioridad de 1. Operaciones masivas que se realizan a través de la secuencia de comandos personalizada deben tener una prioridad más baja.

• peopleToAlert
  Tipo: System.String

  Una lista delimitada por punto y coma de direcciones de correo electrónico de personas a quienes se debe enviar una alerta cuando se completa la transformación. Si la cadena está vacía o una referencia null (Nothing en Visual Basic), no se envía ninguna alerta.

• sendACopy
  Tipo: System.Boolean

  true para adjuntar una copia del documento transformado a la notificación; en caso contrario, false.

• synchronous
  Tipo: System.Boolean

  true para ejecutar la conversión de forma sincrónica; en caso contrario, false.

• workItemId
  Tipo: System.Guid

  Un parámetro de out que obtiene el identificador de la

  elemento de trabajo para esta solicitud asincrónica, o que obtiene Guid.Empty en el caso de una solicitud sincrónica.

Valor devuelto

Tipo: Microsoft.SharePoint.SPFileConversionResult
Un valor de SPFileConversionResult que indica el estado de conversión.

Vea también

Referencia

clase SPFile

Miembros SPFile

Espacio de nombres Microsoft.SharePoint

ISPConversionProcessor