ServerDocument – třída

Článek
05/14/2013

Poskytuje přístup k data uložená v mezipaměti a informace o úpravách v dokumentu nebo sešitu, který je součástí dokumentu úroveň přizpůsobení vytvořené pomocí nástroje pro vývoj Office v sadě 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
	ServerDocument(String)	Inicializuje novou instanci ServerDocument třídy pomocí úplnou cestu k dokumentu má být načten.
	ServerDocument(array<Byte[], String)	Inicializuje novou instanci ServerDocument třídou pomocí bajtové pole, které představuje dokument, který má být načten a příponu názvu souboru dokumentu.
	ServerDocument(Stream, String)	Inicializuje novou instanci ServerDocument třídou datového proudu, který představuje dokument, který chcete načíst a příponu názvu souboru dokumentu.
	ServerDocument(String, FileAccess)	Inicializuje novou instanci ServerDocument třídou pomocí úplnou cestu k dokumentu, který má být načten a hodnota, která určuje přístup k souborům pro dokument.

Nahoru

Vlastnosti

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

Nahoru

Metody

	Název	Popis
	AddCustomization(String, Uri)	O přizpůsobení se připojuje k určený dokument pomocí manifest sestavení zadané jméno a nasazení.
	AddCustomization(String, String, Guid, Uri)	O přizpůsobení se připojuje k určený dokument pomocí zadaného dokumentu, název sestavení, ID řešení a manifest nasazení.
	AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%)	Infrastruktura.
	Close	Zavře ServerDocument objektu.
	Equals	Určuje, zda zadaný objekt je rovno aktuální objekt. (Zděděno z Object.)
	GetCustomizationVersion	Vrátí verzi Visual Studio Tools for Office runtime , který byl použit k vytvoření vlastního nastavení, které souvisí s určený dokument.
	GetHashCode	Slouží jako funkci hash u určitého typu. (Zděděno z Object.)
	GetType	Získá Type aktuální instance. (Zděděno z Object.)
	IsCacheEnabled	Získá hodnotu označující, zda zadaný dokument obsahuje datové mezipaměti.
	IsCustomized	Získá hodnotu označující, zda zadaný dokument obsahuje vlastní nastavení, která byla vytvořena pomocí nástroje Visual Studio 2010 Tools for Office Runtime.
	RemoveCustomization	Vlastní nastavení odebere z dokumentu.
	Save	Uloží změny provedené v dokumentu pomocí ServerDocument třídy.
	ToString	Vrátí řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Nahoru

Explicitní implementace rozhraní

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

Nahoru

Poznámky

Použití ServerDocument třídy spravovat určité aspekty úpravy úroveň dokument v počítači, který nemá aplikaci Excel nebo Word nainstalovány. Tato třída se obvykle používají v aplikacích, které nebylo možné integrovat se sadou Office, jako je například konzola projekty nebo projekty model Windows Forms, spíše než projekty Office.

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

Chcete-li přistupovat a měnit data uložená v mezipaměti data dokumentu na serveru, použijte CachedData vlastnost.
Chcete-li programově k dokumentu připojit vlastního nastavení nebo odebrání vlastního nastavení z dokumentu, použijte AddCustomization a RemoveCustomization metod.
Přístup nebo změna adresy URL manifestu nasazení, který je přidružen k dokumentu, použijte DeploymentManifestUrl vlastnost.

Existují dvě různé verze ServerDocument třídou 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é chcete 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žijte 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 pomocí třídy ServerDocument.

Volba konstruktor, který k použití

Použití ServerDocument třídu pro přístup k data uložená v mezipaměti nebo nasazení manifestu adresy URL v dokumentu, musíte vytvořit ServerDocument objektu.

Existují dvě sady ServerDocument konstruktory:

Sada, která lze použít pro přístup k dokumentu, který již byl otevřen v paměti.
Sada, která lze použít pro přístup k dokumentu, který je na disku.

Přístup k dokumentu v paměti

Chcete-li získat přístup k dokumentu, který již byl otevřen 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 místo určení pomocí protokolu HTTP. Chcete-li použít tyto konstruktory, dokument musí již přizpůsobení; jinak, budou tyto konstruktory vyvolat CannotLoadManifestException výjimku.

Pří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 zadat úplnou cestu k dokumentu, který chcete otevřít. Ve výchozím nastavení je dokument otevřít s přístupem pro čtení i zápis. Pokud chcete otevřít dokument s přístupem jen pro čtení nebo zápis jen pro čtení, použijte konstruktor, který má FileAccess parametr.

Příklady

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

Tento příklad vyžaduje:

Projekt konzolové aplikace 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 bude 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 jazyk Visual Basic) nebo using (pro jazyk C#) příkazy pro Microsoft.VisualStudio.Tools.Applications a Microsoft.VisualStudio.Tools.Applications.Runtime obory názvů na začátku 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 pomocí třídy ServerDocument

Aplikace a nasazení manifestů v Office Solutions

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

Sdílet prostřednictvím

ServerDocument – třída

Hierarchie dědičnosti

Syntaxe

Konstruktory

Vlastnosti

Metody

Explicitní implementace rozhraní

Poznámky

Volba konstruktor, který k použití

Přístup k dokumentu v paměti

Přístup k dokumentu na Disk

Příklady

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

Viz také

Referenční dokumentace

Další zdroje

Další materiály