ServerDocument - конструктор (Stream, String)

Статья
05/19/2013

Инициализирует новый экземпляр класса ServerDocument с помощью потока, который представляет документ, который требуется загрузить, а также расширение файла документа.

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

Синтаксис

'Декларация
Public Sub New ( _
    stream As Stream, _
    fileType As String _
)

public ServerDocument(
    Stream stream,
    string fileType
)

Параметры

stream
Тип: System.IO.Stream
Поток, представляющий документ, который требуется загрузить.

fileType
Тип: System.String
Перед расширением имени файла документа, сохраняемого в параметре bytes, должна стоять точка (.) — например, ".xlsx" или ".docx".

Исключения

Исключение	Условие
ArgumentNullException	Параметр stream имеет значение nullссылка NULL (Nothing в Visual Basic) или пуст. -или- Параметр fileType равен nullссылка NULL (Nothing в Visual Basic), пуст или содержит только пробелы.
ArgumentException	Параметр stream имеет нулевую длину или его текущее положение — в конце потока.
UnknownCustomizationFileException	Параметр fileType задает расширение имени файла, которое не поддерживается средой Visual Studio Tools for Office (cреда выполнения).
DocumentCustomizedWithPreviousRuntimeException	Файл, указанный documentPath имеет настройки, которая не была создана с помощью Visual Studio 2010 для выполнения или office Visual Studio Tools для системы Microsoft Office выполнения (версия 3.0).

Заметки

Этот конструктор используется для получения доступа к кэшированным данным или данным манифеста развертывания в документе, находящемся в памяти.При использовании этого конструктора документ открывается с правом доступа на чтение/запись.

Параметр fileType используется только для определения типа документа, который хранится в массиве данных.Значение fileType сопоставляется с одним из типов файлов, которые поддерживаются настройками уровня документов.Попытка открытия файла не предпринимается.При необходимости можно передавать полное имя файла (например, "Workbook1.xlsx"); однако при этом используется только расширение имени файла.Дополнительные сведения о поддерживаемых типах файлов см. в разделе Архитектура настроек на уровне документа.

Для получения доступа к массиву байтов, чтобы получить документ после вызова этого конструктора, следует использовать свойство Document.

Примеры

В следующем примере кода для создания нового объекта ServerDocument из потока FileStream, содержащего рабочую книгу Excel с расширением имени файла XLSX, используется конструктор ServerDocument(Stream, String).Затем в примере отображается URL-адрес манифеста развертывания для настройки, прикрепленной к документу.

Для этого примера необходимо следующее.

Проект консольного приложения или другой проект, не связанный с Office.
Ссылки на следующие сборки:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll и Microsoft.VisualStudio.Tools.Applications.Runtime.dll (если на которую нацелен проект .NET Framework 4 или .NET Framework 4.5).
  
  или
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll и Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (если проект предназначен для платформы .NET Framework 3.5).
Операторы Imports (для Visual Basic) или using (для C#) для пространств имен Microsoft.VisualStudio.Tools.Applications и Microsoft.VisualStudio.Tools.Applications.Runtime вверху вашего файла с кодом.

Private Sub CreateServerDocumentFromStream(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing
    Dim stream As System.IO.FileStream = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            stream = New System.IO.FileStream(documentPath, System.IO.FileMode.Open)
            serverDocument1 = New ServerDocument(stream, "*.xlsx")
            MessageBox.Show("The URL of the deployment manifest is: " & vbLf & _
                serverDocument1.DeploymentManifestUrl.ToString())
        End If

    Catch ex As System.IO.FileNotFoundException
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
    Catch ex As UnknownCustomizationFileException
        System.Windows.Forms.MessageBox.Show("The specified document has a file " & _
            "extension that is not supported by Visual Studio Tools for Office.")
    Finally
        If Not (serverDocument1 Is Nothing) Then
            serverDocument1.Close()
        End If
        If Not (stream Is Nothing) Then
            stream.Close()
        End If
    End Try
End Sub

private void CreateServerDocumentFromStream(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;
    System.IO.FileStream stream = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            stream = new System.IO.FileStream(
                documentPath, System.IO.FileMode.Open);
            serverDocument1 = new ServerDocument(stream,
                "*.xlsx");
            MessageBox.Show("The URL of the deployment manifest is: \n" +
                serverDocument1.DeploymentManifestUrl.ToString());
        }
    }
    catch (System.IO.FileNotFoundException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
    }
    catch (UnknownCustomizationFileException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document has a file " +
            "extension that is not supported by Visual Studio Tools for Office.");
    }
    finally
    {
        if (serverDocument1 != null)
            serverDocument1.Close();
        if (stream != null)
            stream.Close();
    }
}

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

ServerDocument Класс

ServerDocument - перегрузка

Microsoft.VisualStudio.Tools.Applications - пространство имен

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