Метод SPFile.Convert

Статья
05/13/2015

Примечание. Этот API устарел.

Преобразует файл с помощью указанного преобразователя.

Пространство имен: Microsoft.SharePoint
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
<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
'Применение
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
)

Параметры

ConverterId
Тип: System.Guid

Объект System.Guid , определяющий конкретный документ преобразователь для преобразования документа.

newFileName
Тип: System.String

Строка, содержащая имя конечного файла для создания. Расширение автоматически добавляется с преобразователем.

configInfo
Тип: System.String

Строка, содержащая сведения о конфигурации, который передается приложению преобразование при запросе этого преобразования. Информация для преобразования приложения и может быть пустой строкой или пустой ссылкой (Nothing в Visual Basic).

handlerAssembly
Тип: System.String

Необязательно. Строка, которая указывает сборку для загрузки. Вместе с параметром handlerClass можно указать обработчик преобразования до или после преобразования следует вызвать до или после преобразования для выполнения различных задач с преобразованное содержимое вместо просто платформа преобразования преобразовать его в файл. Значение этого параметра может быть пустая ссылка (Nothing в Visual Basic).

handlerClass
Тип: System.String

Необязательно. Строка, задающая для создания экземпляра класса, определенного в сборке, указанной в параметре handlerAssembly . Класс должен реализовывать интерфейс ISPConversionProcessor и его методы. Вместе с параметром handlerAssembly можно указать обработчик преобразования до или после преобразования следует вызвать до или после преобразования для выполнения различных задач с преобразованное содержимое вместо просто платформа преобразования преобразовать его в файл. Значение этого параметра может быть пустой ссылкой (Nothing в Visual Basic).

priority
Тип: System.Byte

Приоритет этого преобразования. Нижняя

приоритет означает, что данное преобразование будет выполняться быстрее. Преобразования, которые инициируются через пользовательский интерфейс имеет приоритет 1. Массовые операции, выполняемые через пользовательский сценарий должен иметь более низкий приоритет.

peopleToAlert
Тип: System.String

Список разделенных точкой с запятой адреса электронной почты людей, которым необходимо отправить оповещение при завершении преобразования. Если строка пуста или пустая ссылка (Nothing в Visual Basic), оповещение не отправляется.

sendACopy
Тип: System.Boolean

true для присоединения копии преобразованный документ уведомления; в противном случае — false.

synchronous
Тип: System.Boolean

true , чтобы запустить преобразование синхронно; в противном случае — false.

workItemId
Тип: System.Guid

Параметр out , который возвращает идентификатор

рабочий элемент для данного асинхронного запроса или, получает Guid.Empty в случае синхронного запроса.

Возвращаемое значение

Тип: Microsoft.SharePoint.SPFileConversionResult
Значение SPFileConversionResult , указывающее состояние преобразования.

См. также

Справочные материалы

SPFile класс

Элементы SPFile

Пространство имен Microsoft.SharePoint

ISPConversionProcessor

Поделиться через