通过

ServerDocument 构造函数 (Stream, String)

  • 项目

使用表示要加载的文档的流和该文档的文件扩展名，初始化 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
)

参数

  • fileType
    类型：System.String
    文档的文件扩展名，存储在 bytes 参数中，前面有一个句点 (.)，例如“.xlsx”或“.docx”。

异常

异常 条件
ArgumentNullException

stream 参数为 nullnull 引用（在 Visual Basic 中为 Nothing） 或空。

- 或 -

fileType 参数为 nullnull 引用（在 Visual Basic 中为 Nothing） 或为空，或者完全由空白字符组成。
ArgumentException

stream 参数的长度为零或其当前位置位于流的末尾。
UnknownCustomizationFileException

Visual Studio Tools for Office Runtime 不支持 fileType 参数指定的文件扩展名。
DocumentCustomizedWithPreviousRuntimeException

由 documentPath 指定的文件有非 Visual Studio 2010 Tools for Office Runtime 或 Visual Studio Tools for the Microsoft Office system （3.0 版的运行时）创建的自定义。

备注

使用此构造函数可以访问已经在内存中的文档的缓存数据或部署清单信息。使用此构造函数时，文档以读/写访问权限打开。

fileType 参数仅用于确定存储在字节数组中的文档的类型。fileType 的值映射到文档级自定义项所支持的文件类型之一。不尝试打开文件。您可以选择传入完整的文件名（例如“Workbook1.xlsx”），但即使这样做，也只使用文件扩展名。有关支持的文件类型的更多信息，请参见文档级自定义项的体系结构。

若要在调用此构造函数后访问文档的字节数组，请使用 Document 属性。

示例

下面的代码示例使用 ServerDocument(Stream, String) 构造函数，根据文件扩展名为 .xlsx 的 Excel 工作簿的 FileStream 创建新的 ServerDocument。然后，这段代码显示附加到文档的自定义项的部署清单的 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）。

  • 位于代码文件顶部的用于 Microsoft.VisualStudio.Tools.Applications 和 Microsoft.VisualStudio.Tools.Applications.Runtime 命名空间的Imports（对于 Visual Basic）或 using（对于 C#）语句。

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 命名空间