ServerDocument – třída

Článek
08/11/2011

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

Na začátek

Vlastnosti

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

Na začátek

Metody

	Název	Popis
	AddCustomization(String, Uri)	Zadaný dokument přikládá vlastní úpravy pomocí manifestu sestavení zadaný název a nasazení.
	AddCustomization(String, String, Guid, Uri)	Zadaný dokument pomocí zadaného dokumentu, název sestavení, ID řešení a nasazení manifest přikládá vlastní úpravy.
	AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%)	Infrastruktura.
	Close	Zavře ServerDocument objektu.
	Equals	Určuje, zda zadaná Object se rovná aktuální Object. (Zděděno z Object.)
	Finalize	Umožňuje zkuste uvolnit prostředky a provádět další operace vyčištění před je převzaty systémem pro uvolnění objektu. (Zděděno z Object.)
	GetCustomizationVersion	Vrátí verzi Visual Studio Tools for Office runtime , byla použita k vytvoření vlastního nastavení je spojeno s zadaného dokumentu.
	GetHashCode	Slouží jako funkce hash určitého typu. (Zděděno z Object.)
	GetType	Získává Type aktuální instance. (Zděděno z Object.)
	IsCacheEnabled	Hodnota, která určuje, zda má zadaný dokument mezipaměť dat získává.
	IsCustomized	Získá hodnotu označující, zda zadaný dokument má vlastní nastavení, která byla vytvořena pomocí Visual Studio 2010 Tools for Office Runtime.
	MemberwiseClone	Vytvoří kopii aktuální Object. (Zděděno z Object.)
	RemoveCustomization	Odstraní z dokumentu úprav.
	Save	Uloží změny provedené v dokumentu pomocí ServerDocument Třída
	ToString	Vrátí řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Na začátek

Explicitní implementace rozhraní

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

Na začátek

Poznámky

Použití ServerDocument třídy spravovat určité aspekty úpravy ú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é se integrace s Office, například konzoly projekty nebo projekty model Windows Forms místo Office projekty.

Použít následující členy ServerDocument třídy provádět běžné úkoly:

Přístup a úpravy dat v mezipaměti data dokumentu na serveru, použijte CachedData vlastnost.
Programově nastavení připojení k dokumentu nebo odebrat nastavení dokumentu, použijte AddCustomization a RemoveCustomization metod.
Přístup nebo změnit adresu URL manifestu nasazení spojené s dokumentem, použijte DeploymentManifestUrl vlastnost.

Existují dvě různé verze ServerDocument třídy v Visual Studio 2010 Tools for Office Runtime. Verze, kterou použijete, závisí na cíl.NET Framework aplikace, ve kterém chcete použít třídu:

Pro aplikace, které jsou .NET Framework 4, použít Microsoft.VisualStudio.Tools.Applications.ServerDocument třídy v sestavení Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll.
Pro aplikace, které používají.NET Framework 3.5 použití Microsoft.VisualStudio.Tools.Applications.ServerDocument třídy v sestavení Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll.

Další informace naleznete v tématu Managing Documents on a Server by Using the ServerDocument Class.

Volba použití které konstruktor

Použití ServerDocument třídy přístup mezipaměti nebo nasazení manifestu URL v dokumentu, musíte vytvořit ServerDocument objektu.

Existují dvě sady ServerDocument konstruktory:

Sada slouží pro přístup k dokumentu, který je již otevřen v paměti.
Sada slouží pro přístup k dokumentu, který je na disku.

Přístup k dokumentu v paměti

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

Přijmout tyto konstruktory bajtové pole nebo Stream , představuje dokument v paměti. To je užitečné, pokud chcete upravit data v mezipaměti nebo aplikace manifestu v dokumentu před streaming ji k cíli pomocí protokolu HTTP. Chcete-li použít tyto konstruktory dokumentu již přizpůsobení; jinak tyto konstruktory vyvolají CannotLoadManifestException výjimku.

Přístup k dokumentu na disku

Přístup k dokumentu, který je na disku, použijte jednu z následujících konstruktory:

Přijmout tyto konstruktory úplnou cestu k dokumentu, který chcete otevřít. Výchozí 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řipojena k dokumentu.

Tento příklad vyžaduje:

Projekt aplikace konzoly nebo některé jiné-Office project.
Odkazy na následující sestavení:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.dll (pokud cíle projektu .NET Framework 4).
  
  nebo
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll a Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (pokud cíle projektu.NET Framework 3.5).
Imports(pro Visual Basic) nebo using (pro C#) pro příkazy 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();
    }
}

Zabezpečení podprocesu

Všechny veřejné členy static (Shared v jazyce Visual Basic) tohoto typu jsou zabezpečeny pro používání podprocesů. Zabezpečení sdílených členů pro používání podprocesů není zaručeno.