Klasa ServerDocument

Artykuł
01/08/2014

Zapewnia dostęp do buforowanych danych i dostosowywania informacji w dokumencie lub arkuszu, który jest częścią dostosowywania poziomie dokumentu, utworzone za pomocą narzędzi programistycznych pakietu Office w programie Visual Studio.

Hierarchia dziedziczenia

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

Przestrzeń nazw: Microsoft.VisualStudio.Tools.Applications
Zestaw: Microsoft.VisualStudio.Tools.Applications.ServerDocument (w Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Składnia

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

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

Typ ServerDocument uwidacznia następujące elementy członkowskie.

Konstruktorzy

	Nazwa	Opis
	ServerDocument(String)	Inicjuje nowe wystąpienie ServerDocument klasy przy użyciu pełną ścieżkę dokumentu do załadowania.
	ServerDocument(array<Byte[], String)	Inicjuje nowe wystąpienie ServerDocument klasy przy użyciu tablicy bajtowej, która reprezentuje dokument do załadowania i rozszerzenie nazwy pliku dokumentu.
	ServerDocument(Stream, String)	Inicjuje nowe wystąpienie ServerDocument klasy przy użyciu strumienia, który reprezentuje dokument do załadowania i rozszerzenie nazwy pliku dokumentu.
	ServerDocument(String, FileAccess)	Inicjuje nowe wystąpienie ServerDocument klasy przy użyciu pełnej ścieżki dokumentu do załadowania i wartość wskazującą, że dostęp do plików dla danego dokumentu.

Początek

Właściwości

	Nazwa	Opis
	CachedData	Pobiera CachedData obiekt, który reprezentuje buforowane dane zawarte w dokumencie.
	DeploymentManifestUrl	Pobiera lub ustawia adres URL manifestu wdrażania dla dostosowania, jakie są skojarzone z dokumentem.
	Document	Pobiera tablicę bajtów dokument w pamięci, który jest ładowany do ServerDocument.
	SolutionId	Pobiera identyfikator GUID, który Visual Studio 2010 Tools for Office Runtime do identyfikowania rozwiązania.

Początek

Metody

	Nazwa	Opis
	AddCustomization(String, Uri)	Dołącza dostosowań do określonego dokumentu przy użyciu określonego zestawu manifestu nazwy i wdrażania.
	AddCustomization(String, String, Guid, Uri)	Dołącza dostosowań do określonego dokumentu przy użyciu określonego dokumentu, nazwę zestawu, identyfikator rozwiązania i manifest rozmieszczania.
	AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%)	Infrastruktura.
	Close	Zamyka ServerDocument obiektu.
	Equals	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone z Object).
	GetCustomizationVersion	Zwraca informacje o wersji z Visual Studio 2010 Tools for Office Runtime który został użyty do utworzenia dostosowania, jakie są skojarzone z określonego dokumentu.
	GetHashCode	Służy jako domyślnej funkcji mieszania. (Odziedziczone z Object).
	GetType	Pobiera Type bieżącego wystąpienia. (Odziedziczone z Object).
	IsCacheEnabled	Pobiera wartość, która wskazuje, czy określony dokument ma pamięci podręcznej danych.
	IsCustomized	Pobiera wartość, która wskazuje, czy określony dokument ma dostosowania, który został utworzony przy użyciu programu Visual Studio 2010 Tools dla środowiska Office Runtime.
	RemoveCustomization	Usuwa dostosowania dokumentu.
	Save	Powoduje zapisanie wszystkich zmian wprowadzonych do dokumentu za pomocą ServerDocument klasy.
	ToString	Zwraca ciąg, który reprezentuje bieżący obiekt. (Odziedziczone z Object).

Początek

Jawne implementacje interfejsu

	Nazwa	Opis
	IDisposable.Dispose	Zwalnia wszystkie zasoby używane przez ServerDocument.

Początek

Uwagi

Użycie ServerDocument klasy zarządzania niektórymi aspektami dostosowania poziomu dokumentu na komputerze bez zainstalowanego programu Excel lub Word zainstalowany.Klasa ta jest zazwyczaj używana w aplikacjach, które integrują się z pakietu Office, takich jak konsola projektów lub projektów Windows Forms, zamiast projektach dla pakietu Office.

Użyj następujących członków ServerDocument klasy można wykonywać typowe zadania:

Aby uzyskać dostęp i modyfikowanie danych w pamięci podręcznej danych dokumentu na serwerze, należy użyć CachedData właściwość.
Aby programowo Dołączanie pliku dostosowań do dokumentu lub usuwania pliku dostosowań z dokumentu, należy użyć AddCustomization i RemoveCustomization metody.
Aby uzyskać dostęp lub zmienić adres URL manifest wdrażania, która jest skojarzona z dokumentem, należy użyć DeploymentManifestUrl właściwość.

Istnieją dwie różne wersje ServerDocument klasy w Visual Studio 2010 Tools for Office Runtime.Należy użyć wersji zależy od docelowej.NET Framework aplikacji, w którym chcesz użyć klasy:

Dla aplikacji przeznaczonych dla .NET Framework 4 lub .NET Framework 4.5, użyj Microsoft.VisualStudio.Tools.Applications.ServerDocument klasy w zestawie Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll.
W przypadku aplikacji przeznaczonych dla.NET Framework 3.5, użyć Microsoft.VisualStudio.Tools.Applications.ServerDocument klasy w zestawie Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll.

Aby uzyskać więcej informacji, zobacz Zarządzanie dokumentami na serwerze za pomocą klasy ServerDocument.

Wybieranie które Konstruktor do użycia

Aby użyć ServerDocument klasy dostępu do buforowanych danych lub wdrażanie manifestu adres URL w dokumencie, należy utworzyć ServerDocument obiektu.

Istnieją dwa zestawy ServerDocument konstruktory:

Zestaw, który umożliwia dostęp do dokumentu, który został już otwarty w pamięci.
Zestaw, który umożliwia dostęp do dokumentu, który znajduje się na dysku.

Dostęp do dokumentów w pamięci

Dostęp do dokumentu, który został już otwarty w pamięci, należy użyć jednej z następujących konstruktory:

Te konstruktory zaakceptować tablicy bajtowej lub Stream reprezentująca dokumentu w pamięci.Jest to przydatne, jeśli chcesz zmodyfikować dane buforowane lub aplikacji manifestu w dokumencie przed przesłaniem go do miejsca docelowego przy użyciu protokołu HTTP.Aby użyć tych konstruktorów, dokument musi być już związana dostosowania; w przeciwnym wypadku te konstruktory będzie rzucić CannotLoadManifestException wyjątku.

Dostęp do dokumentu na dysku

Dostęp do dokumentu, który znajduje się na dysku, użyj jednej z następujących konstruktory:

Te konstruktory przyjąć pełną ścieżkę dokumentu, który chcesz otworzyć.Domyślnie dokument jest otwierany z dostępem do odczytu i zapisu.Jeśli chcesz otworzyć dokument z dostępem tylko do odczytu lub tylko do zapisu, użyj konstruktora, który ma FileAccess parametru.

Przykłady

Poniższy przykład kodu tworzy nowy ServerDocument który wczytuje określony dokument, a następnie wyświetla adres URL manifestu wdrażania dla dostosowania, który jest dołączony do dokumentu.

W tym przykładzie wymaga:

Projekt aplikacji konsoli lub innych projektów nienależących do pakietu Office.
Odwołania do następujących zestawów:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll i Microsoft.VisualStudio.Tools.Applications.Runtime.dll (jeśli cele projektu .NET Framework 4 lub .NET Framework 4.5).
  
  lub
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll i Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (Jeśli projekt jest przeznaczony dla.NET Framework 3.5).
Imports(dla Visual Basic) lub using (w przypadku C#) oświadczenia dla Microsoft.VisualStudio.Tools.Applications i Microsoft.VisualStudio.Tools.Applications.Runtime obszarów nazw u góry pliku kodu.

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();
    }
}

Bezpieczeństwo wątku

Wszystkie publiczne static (Shared w języku Visual Basic) elementy członkowskie tego typu są bezpieczne dla wątków. Wystąpienia elementów członkowskich nie dają gwarancji bezpieczeństwa wątków.

Zobacz też

Informacje

Przestrzeń nazw Microsoft.VisualStudio.Tools.Applications

Inne zasoby

Zarządzanie dokumentami na serwerze za pomocą klasy ServerDocument

Aplikacje i manifesty wdrożenia w rozwiązaniach pakietu Office

Uzyskiwanie dostępu do danych w dokumentach na serwerze

Udostępnij za pośrednictwem

Klasa ServerDocument

Hierarchia dziedziczenia

Składnia

Konstruktorzy

Właściwości

Metody

Jawne implementacje interfejsu

Uwagi

Wybieranie które Konstruktor do użycia

Dostęp do dokumentów w pamięci

Dostęp do dokumentu na dysku

Przykłady

Bezpieczeństwo wątku

Zobacz też

Informacje

Inne zasoby

Dodatkowe zasoby