Klasa ServerDocument

Artykuł
05/08/2013

Zapewnia dostęp do pamięci podręcznej danych i informacje na temat dostosowywania w dokumencie lub skoroszycie, 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, używając pełnej ścieżki 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 za pomocą 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ąca, ż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, które jest skojarzone z dokumentem.
	Document	Pobiera tablicę bajtów dokumentu 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 nazwę i wdrażania.
	AddCustomization(String, String, Guid, Uri)	Dołącza dostosowań do określonego dokumentu przy użyciu określonego dokumentu, nazwa zestawu, identyfikator rozwiązania i rozmieszczenia oczywiste.
	AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%)	Infrastruktura.
	Close	Zamyka ServerDocument obiektu.
	Equals	Określa, czy określony obiekt jest równa bieżącego obiektu. (Odziedziczone z Object).
	GetCustomizationVersion	Zwraca informacje o wersji z Visual Studio 2010 Tools for Office Runtime który został użyty do utworzenia dostosowania, który jest skojarzony z określonego dokumentu.
	GetHashCode	Służy jako funkcja mieszania dla określonego typu. (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 narzędzi Visual Studio 2010 Tools dla środowiska Office Runtime.
	RemoveCustomization	Dostosowanie usuwa z dokumentu.
	Save	Zapisuje wszystkie zmiany, które zostały wprowadzone do dokumentu za pomocą ServerDocument klasy.
	ToString	Zwraca wartość typu 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 dostosowań poziomie dokumentu na komputerze bez zainstalowanego programu Excel lub Word zainstalowany.Klasa ta jest zazwyczaj używana w aplikacjach, które nie włączają je z pakietem 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 do wykonywania typowych zadań:

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

Istnieją dwie wersje ServerDocument klasy w Visual Studio 2010 Tools for Office Runtime.Wersja, należy użyć zależy od.NET Framework aplikacji docelowej w której chcesz użyć klasy:

Dla aplikacji, które współpracować z .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 aplikacje przeznaczone 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 konstruktora służącego do użycia

Aby użyć ServerDocument klasy dostępu do buforowanych danych lub rozmieszczenie manifest 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 już został otwarty w pamięci.
Zestaw, który umożliwia dostęp do dokumentu, który znajduje się na dysku.

Uzyskiwanie dostępu 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 bajtów lub Stream , oznaczającą 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 powinien być już dostosowań; w przeciwnym wypadku spowoduje zgłoszenie te konstruktory CannotLoadManifestException wyjątku.

Uzyskiwanie dostępu 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 uprawnieniami do odczytu/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 ładuje określonego dokumentu, 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 innego projektu 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 języka Visual Basic) lub using (dla języka 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

Aplikacja i manifestów wdrażania rozwiązań 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 konstruktora służącego do użycia

Uzyskiwanie dostępu do dokumentów w pamięci

Uzyskiwanie dostępu do dokumentu na dysku

Przykłady

Bezpieczeństwo wątku

Zobacz też

Informacje

Inne zasoby

Dodatkowe zasoby