Sdílet prostřednictvím


ServerDocument.Save-Methode (2007 System)

Aktualisiert: November 2007

Speichert alle Änderungen, die am Dokument mithilfe der ServerDocument-Klasse vorgenommen wurden.

Namespace:  Microsoft.VisualStudio.Tools.Applications
Assembly:  Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0 (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll)

Syntax

'Declaration
Public Sub Save
'Usage
Dim instance As ServerDocument

instance.Save()
public void Save()

Ausnahmen

Ausnahme Bedingung
DocumentClosedException

Das ServerDocument wurde geschlossen.

MissingHostItemIdException

Die Id-Eigenschaft eines CachedDataHostItem ist nullNULL-Verweis (Nothing in Visual Basic) oder leer.

MissingDataIdException

Die Id-Eigenschaft eines CachedDataItem ist nullNULL-Verweis (Nothing in Visual Basic) oder leer.

MissingTypeException

Die DataType-Eigenschaft eines CachedDataItem ist nullNULL-Verweis (Nothing in Visual Basic) oder leer.

Hinweise

Die Save-Methode speichert alle an den zwischengespeicherten Daten oder der Bereitstellungsmanifest-URL im Dokument vorgenommenen Änderungen. Wenn Sie das ServerDocument-Objekt mithilfe eines Dokuments auf einem Datenträger erstellt haben, speichert diese Methode diese Änderungen auf den Datenträger. Wenn Sie das ServerDocument-Objekt mithilfe eines Dokuments im Arbeitsspeicher erstellt haben, speichert diese Methode diese Änderungen im Speicherpuffer.

Beispiele

Das folgende Codebeispiel erstellt ein neues ServerDocument für eine angegebene Excel-Arbeitsmappe, ändert mit der SerializeDataInstance-Methode den Wert einer Zeichenfolge, die in einer Arbeitsmappe zwischengespeichert ist, und verwendet anschließend die Save-Methode, um die Änderung zu speichern.

Für dieses Beispiel ist am Anfang der Codedatei ein Verweis auf die Assemblys Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll sowie auf die Anweisung Imports (für Visual Basic) oder using (für C#) für die Namespaces Microsoft.VisualStudio.Tools.Applications und Microsoft.VisualStudio.Tools.Applications.Runtime erforderlich. Außerdem wird vorausgesetzt, dass die angegebene Arbeitsmappe über eine Anpassung mit einer Sheet1-Klasse im ExcelWorkbook1-Namespace und einer zwischengespeicherten Zeichenfolge in einer Sheet1-Klasse mit dem Namen CachedString verfügt.

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

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion <> 3 Then
            MessageBox.Show("This document does not have a Visual Studio Tools for Office " & _
                "customization, or it has a customization that was created with a version of " & _
                "the runtime that is incompatible with this version of the ServerDocument class.")
            Return
        End If

        If ServerDocument.IsCacheEnabled(documentPath) Then
            serverDocument1 = New ServerDocument(documentPath)
            Dim hostItem1 As CachedDataHostItem = _
                serverDocument1.CachedData.HostItems("ExcelWorkbook1.Sheet1")
            Dim dataItem1 As CachedDataItem = hostItem1.CachedData("CachedString")

            If dataItem1 IsNot Nothing AndAlso _
                Type.GetType(dataItem1.DataType).Equals(GetType(String)) Then

                dataItem1.SerializeDataInstance("This is the new cached string value.")
                serverDocument1.Save()
            End If
        Else
            MessageBox.Show("The specified document does not have cached data.")
        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 ModifyCachedString(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);

        if (runtimeVersion != 3)
        {
            MessageBox.Show("This document does not have a Visual Studio Tools for " +
                "Office customization, or it has a customization that was created with " +
                "a version of the runtime that is incompatible with this version of the " +
                "ServerDocument class.");
            return;
        }

        if (ServerDocument.IsCacheEnabled(documentPath))
        {
            serverDocument1 = new ServerDocument(documentPath);
            CachedDataHostItem hostItem1 = 
                serverDocument1.CachedData.HostItems["ExcelWorkbook1.Sheet1"];
            CachedDataItem dataItem1 = hostItem1.CachedData["CachedString"];

            if (dataItem1 != null &&
                Type.GetType(dataItem1.DataType) == typeof(string))
            {
                dataItem1.SerializeDataInstance("This is the new cached string value.");
                serverDocument1.Save();
            }
        }
        else
        {
            MessageBox.Show("The specified document does not have cached data.");
        }
    }
    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();
    }
}

Berechtigungen

Siehe auch

Referenz

ServerDocument-Klasse

ServerDocument-Member

Microsoft.VisualStudio.Tools.Applications-Namespace