Sdílet prostřednictvím

ServerDocument – třída

  • Článek

Poskytuje přístup k data uložená v mezipaměti a přizpůsobení informací v dokumentu nebo sešitu, který je součástí dokumentu úroveň přizpůsobení, vytvořených pomocí nástroje Office vývoj v Visual Studio.

Hierarchie dědičnosti

System.Object
  Microsoft.VisualStudio.Tools.Applications.ServerDocument

Obor názvů:  Microsoft.VisualStudio.Tools.Applications
Sestavení:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (v Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntaxe

'Deklarace
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public NotInheritable Class ServerDocument _
    Implements IDisposable

[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class ServerDocument : IDisposable

Typ ServerDocument zveřejňuje následující členy.

Konstruktory

  Název Popis
Veřejná metoda ServerDocument(String) Inicializuje novou instanci ServerDocument třídy úplnou cestu dokumentu pomocí má být načten.
Veřejná metoda ServerDocument(array<Byte[], String) Inicializuje novou instanci ServerDocument třídy pomocí bajtové pole, které představuje dokument, který má být načten a příponu názvu souboru dokumentu.
Veřejná metoda ServerDocument(Stream, String) Inicializuje novou instanci ServerDocument třídy pomocí datového proudu, který představuje dokument, který má být načten a příponu názvu souboru dokumentu.
Veřejná metoda ServerDocument(String, FileAccess) Inicializuje novou instanci ServerDocument třídy úplné cesty dokumentu mají být načtena a hodnotu, která označuje přístup k souborům pro dokument.

Nahoru

Vlastnosti

  Název Popis
Veřejná vlastnost CachedData Získá CachedData objekt představující data uložená v mezipaměti, které jsou obsaženy v dokumentu.
Veřejná vlastnost DeploymentManifestUrl Získá nebo nastaví adresu URL manifestu nasazení vlastního nastavení, který je spojen s dokumentem.
Veřejná vlastnost Document Získá bajtové pole z dokumentu v paměti, který je načten do ServerDocument.
Veřejná vlastnost SolutionId Získá identifikátor GUID, který Visual Studio Tools for Office runtime používá k identifikaci řešení.

Nahoru

Metody

  Název Popis
Veřejná metodaStatický člen AddCustomization(String, Uri) O přizpůsobení se připojí k zadaný dokument pomocí zadané sestavení název a nasazení manifestu.
Veřejná metodaStatický člen AddCustomization(String, String, Guid, Uri) O přizpůsobení se připojí k zadaný dokument pomocí zadaného dokumentu, název sestavení, ID řešení a manifestu nasazení.
Veřejná metodaStatický člen AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%) Infrastruktura.
Veřejná metoda Close Zavře ServerDocument objektu.
Veřejná metoda Equals Určuje, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno z Object.)
Veřejná metodaStatický člen GetCustomizationVersion Vrátí verzi Visual Studio Tools for Office runtime , který byl použit k vytvoření vlastního nastavení, které souvisí s zadaný dokument.
Veřejná metoda GetHashCode Slouží jako výchozí funkce hash. (Zděděno z Object.)
Veřejná metoda GetType Získá Type aktuální instance. (Zděděno z Object.)
Veřejná metodaStatický člen IsCacheEnabled Získá hodnotu, která označuje, zda má zadaný dokument v mezipaměti data.
Veřejná metodaStatický člen IsCustomized Získá hodnotu, která označuje, zda zadaný dokument obsahuje vlastní nastavení, která byla vytvořena pomocí aplikace Visual Studio 2010 Tools for Office Runtime.
Veřejná metodaStatický člen RemoveCustomization Vlastní nastavení odstraní z dokumentu.
Veřejná metoda Save Uloží změny provedené v dokumentu pomocí ServerDocument třídy.
Veřejná metoda ToString Vrací řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Nahoru

Explicitní implementace rozhraní

  Název Popis
Explicitní implementace rozhraníSoukromá metoda IDisposable.Dispose Uvolní všechny prostředky používané ServerDocument.

Nahoru

Poznámky

Použití ServerDocument třídy spravovat určité aspekty úpravy na úrovni dokumentu v počítači, který nemá aplikaci Excel nebo Word nainstalovány.Tato třída se obvykle používají v aplikacích, které není integraci se sadou Office, například konzoly projekty nebo projekty model Windows Forms, spíše než Office projekty.

Použít následující členy ServerDocument třídy pro provádění běžných úloh:

  • K přístupu a úpravě dat v mezipaměti data dokumentu na serveru, použijte CachedData vlastnost.

  • Chcete-li programově připojit k dokumentu úpravám nebo odebrání vlastního nastavení z dokumentu, použijte AddCustomization a RemoveCustomization metody.

  • Přístup nebo změna adresy URL manifestu nasazení, který je spojen s dokumentem, můžete DeploymentManifestUrl vlastnost.

Existují dvě různé verze ServerDocument třídy v Visual Studio 2010 Tools for Office Runtime.Verzi, měli byste použít, závisí na cílové rozhraní.NET Framework aplikace, ve které si přejete použít třídu:

  • U aplikací, které se zaměřují .NET Framework 4 nebo .NET Framework 4.5, použít Microsoft.VisualStudio.Tools.Applications.ServerDocument třídy v sestavení Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll.

  • U aplikací, které jsou cíleny na rozhraní.NET Framework 3.5, použít Microsoft.VisualStudio.Tools.Applications.ServerDocument třídy v sestavení Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll.

Další informace naleznete v tématu Správa dokumentů na serveru s použitím třídy ServerDocument.

Volba které konstruktor pro použití

Chcete-li použít ServerDocument třídy pro přístup k data uložená v mezipaměti nebo nasazení manifest adresy URL v dokumentu, je třeba vytvořit ServerDocument objektu.

Existují dvě sady ServerDocument konstruktory:

  • Sada, která lze použít k přístupu k dokumentu, který byl otevřen již v paměti.

  • Sada, která lze použít k přístupu k dokumentu, který je na disku.

Bb514484.collapse_all(cs-cz,VS.120).gifPřístup k dokumentu v paměti

Chcete-li získat přístup k dokumentu, který byl otevřen již v paměti, použijte jednu z následujících konstruktory:

Tyto konstruktory přijímat bajtové pole nebo Stream , která představuje dokumentů v paměti.To je užitečné, pokud chcete upravit data uložená v mezipaměti nebo aplikace manifestu v dokumentu před streaming na cíl pomocí protokolu HTTP.Chcete-li použít tyto konstruktory, dokument již přizpůsobení; jinak, budou tyto konstruktory vyvolat CannotLoadManifestException výjimku.

Bb514484.collapse_all(cs-cz,VS.120).gifPřístup k dokumentu na Disk

Chcete-li získat přístup k dokumentu, který je na disku, použijte jednu z následujících konstruktory:

Tyto konstruktory přijmout úplnou cestu dokumentu, který chcete otevřít.Ve výchozím nastavení je dokument otevřít s přístupem pro čtení i zápis.Pokud chcete dokument otevřít s přístupem jen pro čtení nebo jen pro zápis, použijte konstruktor, který má FileAccess parametr.

Příklady

Následující příklad kódu vytvoří nový ServerDocument , načte zadaný dokument a potom zobrazí adresu URL manifestu nasazení vlastního nastavení, který je připojen k dokumentu.

Tento příklad vyžaduje:

  • Projekt aplikace konzoly nebo jiného projektu mimo sadu Office.

  • Odkazy na následující sestavení:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.dll (Pokud projekt cílen .NET Framework 4 nebo .NET Framework 4.5).

      nebo

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (Pokud je projekt cílen na rozhraní.NET Framework 3.5).

  • Imports(pro Visual Basic) nebo using (pro jazyk C#) příkazy pro Microsoft.VisualStudio.Tools.Applications a Microsoft.VisualStudio.Tools.Applications.Runtime obory názvů v horní části souboru kódu.

Private Sub CreateServerDocumentFromPath(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            serverDocument1 = New ServerDocument(documentPath)
            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
    End Try
End Sub

private void CreateServerDocumentFromPath(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            serverDocument1 = new ServerDocument(documentPath);
            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();
    }
}

Bezpečný přístup z více vláken

Všechny veřejné členy static (Shared v jazyce Visual Basic) tohoto typu jsou bezpečné pro přístup z více vláken. Není zaručeno, že členy instancí jsou bezpečné pro přístup z více vláken.

Viz také

Referenční dokumentace

Microsoft.VisualStudio.Tools.Applications – obor názvů

Další zdroje

Správa dokumentů na serveru s použitím třídy ServerDocument

Manifesty aplikací a nasazení v řešeních pro systém Office

Přístup k datům v dokumentech na serveru