ServerDocument Sınıf

Tanım

Visual Studio 'da Office geliştirme araçları kullanılarak oluşturulan belge düzeyi özelleştirmenin parçası olan bir belge veya çalışma kitabındaki önbelleğe alınmış verilere ve özelleştirme bilgilerine erişim sağlar.

public sealed class ServerDocument : IDisposable
Devralma
ServerDocument
Uygulamalar

Örnekler

Aşağıdaki kod örneği, belirtilen bir belgeyi yükleyen yeni bir oluşturur ServerDocument ve ardından belgeye iliştirilmiş özelleştirmenin dağıtım BILDIRIMININ URL 'sini görüntüler.

Bu örnek şunları gerektirir:

  • Bir konsol uygulaması projesi veya başka bir Office dışı proje.

  • Aşağıdaki derlemelere başvurur:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll ve Microsoft.VisualStudio.Tools.Applications.Runtime.dll (proje veya ' i hedefliyorsa .NET Framework 4 .NET Framework 4.5 ).

      veya

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll ve Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (proje .NET Framework 3.5'i hedefliyorsa).

  • Imports(for Visual Basic) veya using (for C#) deyimleri, Microsoft.VisualStudio.Tools.Applications ve için Microsoft.VisualStudio.Tools.Applications.Runtime Kod dosyanızın en üstünde bulunan ad alanları.

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

Açıklamalar

ServerDocumentExcel veya Word yüklü olmayan bir bilgisayardaki belge düzeyi özelleştirmelerinin belirli yönlerini yönetmek için sınıfını kullanın. Bu sınıfı genellikle, Office projeleri yerine konsol projeleri veya Windows Forms projeleri gibi Office ile tümleştirilebilen uygulamalarda kullanırsınız.

ServerDocumentOrtak görevleri gerçekleştirmek için sınıfının aşağıdaki üyelerini kullanın:

  • Bir sunucudaki bir belgenin veri önbelleğindeki verilere erişmek ve verileri değiştirmek için CachedData özelliğini kullanın.

  • Bir belgeye programlı bir şekilde özelleştirme iliştirmek veya bir özelleştirmeyi bir belgeden kaldırmak için AddCustomization ve RemoveCustomization yöntemlerini kullanın.

  • Belgeyle ilişkili dağıtım bildiriminin URL 'sine erişmek veya bu URL 'yi değiştirmek için DeploymentManifestUrl özelliğini kullanın.

ServerDocumentOffice çalışma zamanı Için Visual Studio 2010 araçlarında sınıfının iki farklı sürümü vardır. Kullanmanız gereken sürüm, sınıfını kullanmak istediğiniz uygulamanın hedef .NET Framework bağlıdır:

  • Veya öğesini hedefleyen uygulamalar için .NET Framework 4 .NET Framework 4.5 Microsoft.VisualStudio.Tools.Applications.ServerDocument Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll derlemesinde sınıfını kullanın.

  • .NET Framework 3,5 ' i hedefleyen uygulamalar için Microsoft.VisualStudio.Tools.Applications.ServerDocument Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll derlemesindeki sınıfını kullanın.

Daha fazla bilgi için, bkz. ServerDocument sınıfını kullanarak sunucuda belge yönetme.

Hangi Oluşturucunun Kullanılacağını Seçme

ServerDocumentBir belgedeki önbelleğe alınmış verilere veya dağıtım bildirimi URL 'sine erişmek için sınıfını kullanmak üzere bir nesnesi oluşturmanız gerekir ServerDocument .

İki Oluşturucu kümesi vardır ServerDocument :

  • Bellekte zaten açılmış olan bir belgeye erişmek için kullanabileceğiniz bir küme.

  • Diskteki bir belgeye erişmek için kullanabileceğiniz bir küme.

Bellekteki Bir Belgeye Erişme

Bellekte zaten açılmış olan bir belgeye erişmek için aşağıdaki oluşturuculardan birini kullanın:

Bu oluşturucular Stream , bellekteki belgeyi temsil eden bir bayt dizisi veya bir bayt dizisi kabul eder. Bu, HTTP protokolünü kullanarak bir hedefe veri akışı yapmadan önce, belgedeki önbelleğe alınmış verileri veya uygulama bildirimini değiştirmek istediğinizde yararlıdır. Bu oluşturucuları kullanmak için belge zaten bir özelleştirmeye sahip olmalıdır; Aksi takdirde, bu oluşturucular bir CannotLoadManifestException özel durum oluşturur.

Diskteki Bir Belgeye Erişme

Diskteki bir belgeye erişmek için aşağıdaki oluşturuculardan birini kullanın:

Bu oluşturucular, açmak istediğiniz belgenin tam yolunu kabul eder. Varsayılan olarak belge, okuma/yazma erişimiyle açılır. Belgeyi salt okuma veya salt yazma erişimiyle açmak isterseniz, bir parametreye sahip olan oluşturucuyu kullanın FileAccess .

Oluşturucular

ServerDocument(Byte[], String)

ServerDocumentYüklenecek belgeyi ve belgenin dosya adı uzantısını temsil eden bir bayt dizisi kullanarak sınıfının yeni bir örneğini başlatır.

ServerDocument(Stream, String)

ServerDocumentYüklenecek belgeyi ve belgenin dosya adı uzantısını temsil eden bir akış kullanarak sınıfının yeni bir örneğini başlatır.

ServerDocument(String)

ServerDocumentYüklenecek belgenin tam yolunu kullanarak sınıfının yeni bir örneğini başlatır.

ServerDocument(String, FileAccess)

ServerDocumentYüklenecek belgenin tam yolunu ve belge için dosya erişimini gösteren bir değeri kullanarak sınıfının yeni bir örneğini başlatır.

Özellikler

CachedData

CachedDataBelgede bulunan önbelleğe alınmış verileri temsil eden bir nesne alır.

DeploymentManifestUrl

Belgeyle ilişkili özelleştirme için dağıtım bildiriminin URL 'sini alır veya ayarlar.

Document

İçine yüklenen bellek içi belgenin bayt dizisini alır ServerDocument .

SolutionId

Office çalışma zamanı için Visual Studio AraçlarıÇözümü tanımlamak için kullandığı GUID 'yi alır.

Yöntemler

AddCustomization(String, String, Guid, Uri)

Belirtilen belge, derleme adı, çözüm KIMLIĞI ve dağıtım bildirimini kullanarak belirtilen belgeye bir özelleştirme iliştirir.

AddCustomization(String, String, Guid, Uri, Boolean, String[])
AddCustomization(String, Uri)

Belirtilen derleme adı ve dağıtım bildirimini kullanarak belirtilen belgeye bir özelleştirme iliştirir.

Close()

Nesneyi kapatır ServerDocument .

Finalize()
GetCustomizationVersion(String)

Office çalışma zamanı için Visual Studio AraçlarıBelirtilen belgeyle ilişkili özelleştirmeyi oluşturmak için kullanılan sürümünü döndürür.

IsCacheEnabled(String)

Belirtilen belgenin bir veri önbelleğine sahip olup olmadığını gösteren bir değer alır.

IsCustomized(String)

Belirtilen belgenin Office çalışma zamanı için Visual Studio 2010 araçları kullanılarak oluşturulmuş bir özelleştirmeye sahip olup olmadığını gösteren bir değer alır.

RemoveCustomization(String)

Özelleştirmeyi belgeden kaldırır.

Save()

Sınıfını kullanarak belge üzerinde yapılan değişiklikleri kaydeder ServerDocument .

Belirtik Arabirim Kullanımları

IDisposable.Dispose()

ServerDocument tarafından kullanılan tüm kaynakları serbest bırakır.

Şunlara uygulanır