ServerDocument Sınıf

Makale
02/17/2014

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

Devralma Hiyerarşisi

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

Ad alanı: Microsoft.VisualStudio.Tools.Applications
Derleme: Microsoft.VisualStudio.Tools.Applications.ServerDocument (Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll içinde)

Sözdizimi

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

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

ServerDocument türü aşağıdaki üyeleri ortaya koyar.

Oluşturucular

	Ad	Açıklama
	ServerDocument(String)	Yeni bir örneğini başlatır ServerDocument yüklenecek olan belgenin tam yolu kullanarak sınıf.
	ServerDocument(array<Byte[], String)	Yeni bir örneğini başlatır ServerDocument yüklenebilmesi için belgeyi temsil eden bir bayt dizisi ve belgenin dosya adı uzantısını kullanarak sınıf.
	ServerDocument(Stream, String)	Yeni bir örneğini başlatır ServerDocument yüklenebilmesi için belgeyi temsil eden bir akış ve belgenin dosya adı uzantısını kullanarak sınıf.
	ServerDocument(String, FileAccess)	Yeni bir örneğini başlatır ServerDocument yüklenecek belge ve belgenin dosya erişimi gösteren bir değeri tam yolunu kullanarak sınıf.

Üst

Özellikler

	Ad	Açıklama
	CachedData	Alır bir CachedData belgede bulunan önbelleğe alınmış verileri temsil eden nesne.
	DeploymentManifestUrl	Alır veya ayarlar belge ile ilişkili özelleştirme için dağıtım bildiriminin URL'i.
	Document	Bellek içi belgesinin içine yüklenen bayt dizisi alır ServerDocument.
	SolutionId	Bir GUID, alır Office için Visual Studio Araçları çalışma zamanı modülü çözüm tanımlamak için kullanır.

Üst

Yöntemler

	Ad	Açıklama
	AddCustomization(String, Uri)	Bir özelleştirme belirtilen derleme adı ve dağıtım bildirimini kullanarak belirli bir belgeye ekler.
	AddCustomization(String, String, Guid, Uri)	Bir özelleştirme belirtilen belge, derleme adı, çözüm kimliği ve dağıtım bildirimini kullanarak belirli bir belgeye ekler.
	AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%)	Altyapı.
	Close	Kapatır ServerDocument nesne.
	Equals	Belirtilen nesnenin geçerli nesneyle eşit olup olmadığını belirler. (Object kaynağından devralındı.)
	GetCustomizationVersion	Sürümünü döndürür Office için Visual Studio Araçları çalışma zamanı modülü belirtilen belge ile ilişkili özelleştirme oluşturmak için kullanıldı.
	GetHashCode	Varsayılan karma işlevi hizmet verir. (Object kaynağından devralındı.)
	GetType	Alır Type geçerli örneğinin. (Object kaynağından devralındı.)
	IsCacheEnabled	Belirtilen belge veri önbelleği olup olmadığını gösteren bir değeri alır.
	IsCustomized	Belirtilen belge Office Runtime için Visual Studio 2010 araçları kullanılarak oluşturulmuş bir özelleştirme olup olmadığını gösteren bir değeri alır.
	RemoveCustomization	Özelleştirme belgeden kaldırır.
	Save	Kullanarak belgede yapılan tüm değişiklikleri kaydeder ServerDocument sınıf.
	ToString	Geçerli nesneyi temsil eden bir dize döndürür. (Object kaynağından devralındı.)

Üst

Açık Arabirim Uygulamaları

	Ad	Açıklama
	IDisposable.Dispose	Tarafından kullanılan tüm kaynakları serbest bırakır ServerDocument.

Üst

Notlar

Kullanım ServerDocument belge düzeyi özelleştirmelerinde Excel yüklü olmayan bir bilgisayarda belirli yönlerini yönetmek için sınıf veya Word'ün yüklü.Bu sınıf genellikle konsol projeleri veya Windows Form projelerindeki yerine gibi Office projeleri Office ile entegre olmayan uygulamalarda kullanılır.

Aşağıdaki üyeleri kullanmak ServerDocument sınıf ortak görevleri gerçekleştirmek için:

Sunucu üzerindeki bir belgede veri önbelleğine'deki verileri değiştirmek ve erişmek için kullanın CachedData özelliği.
Programlı olarak özelleştirme belgeye iliştirmek veya bir özelleştirme belgeden kaldırmak için kullanın AddCustomization ve RemoveCustomization yöntemleri.
Erişmek veya belge ile ilişkili dağıtım bildiriminin URL'i değiştirmek için DeploymentManifestUrl özelliği.

İki farklı sürümü vardır ServerDocument Office çalıştırma zamanı için Visual Studio 2010 Araçları sınıfında.Hedef .NET Framework uygulaması kullanması gereken sürüm bağlıdır sınıfını kullanmak istediğiniz:

' İ hedefleyen uygulamalar için .NET Framework 4 veya .NET Framework 4.5, kullanın Microsoft.VisualStudio.Tools.Applications.ServerDocument Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll derlemesindeki sınıf.
Microsoft.VisualStudio.Tools.Applications.ServerDocument'i hedefleyen uygulamalarda Microsoft.VisualStudio.Tools.Applications.ServerDocument.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şturucuyu kullanmak için seçme

Kullanmak için ServerDocument bir belgede önbelleğe alınmış veriyi veya dağıtım erişmek için sınıf bildirimi URL'oluşturmanız gerekir bir ServerDocument nesne.

İki adet vardır ServerDocument kurucuları:

Bellekte bir zaten açık bir belgeye erişmek için kullanabileceğiniz küme.
Disk üzerinde bir belgeye erişmek için kullanabileceğiniz küme.

Bir belgeyi belleğe erişme

Bellekte bir zaten açık bir belgeye erişmek için aşağıdaki oluşturucular birini kullanın:

Bir bayt dizisi Bu oluşturucuları kabul veya bir Stream , bellekte belgeyi temsil eden.Bu önbelleğe alınan verileri veya uygulamayı değiştirmek istiyorsanız yararlıdır HTTP protokolünü kullanarak bir hedefe akış önce belgedeki bildirim.Bu oluşturucular kullanmak için bir özelleştirme, belge zaten olması gerekir; Aksi halde, bu oluşturucuları atar bir CannotLoadManifestException özel durum.

Diskteki belge erişme

Disk üzerinde bir belgeye erişmek için aşağıdaki oluşturucular birini kullanın:

Bu Oluşturucular, açmak istediğiniz belgenin tam yolu kabul edin.Varsayılan olarak, okuma/yazma erişimiyle belge açılır.Salt okunur veya salt yazılır erişimi olan bir belgeyi açmak istiyorsanız, sahip bir Oluşturucu kullanın bir FileAccess parametresi.

Örnekler

Aşağıdaki kod örneği oluşturur Yeni bir ServerDocument , belirtilen bir belge yükler ve sonra belgeye iliştirilmiş özelleştirme için dağıtım bildiriminin URL'sini görüntüler.

Bu örnek aşağıdakileri gerektirir:

Konsol uygulama projesi veya başka bir Office dışı proje.
Aşağıdaki derlemelere başvurular:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll ve Microsoft.VisualStudio.Tools.Applications.Runtime.dll (durumunda proje hedefleri .NET Framework 4 veya .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 hedefliyorsa).
Imports(Visual Basic için) veya using için (C#) deyimleri için Microsoft.VisualStudio.Tools.Applications ve Microsoft.VisualStudio.Tools.Applications.Runtime kod dosyanın üst ad.

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

İş Parçacığı Güvenliği

Bu türün tüm genel statik (Visual Basic'te Shared) üyeleri iş parçacığı açısından güvenlidir. Hiçbir örnek üyesinin iş parçacığı açısından güvenliği garanti edilemez.

Ayrıca bkz.

Başvuru

Microsoft.VisualStudio.Tools.Applications Ad Alanı

Diğer Kaynaklar

ServerDocument Sınıfını Kullanarak Sunucuda Belge Yönetme

Office Çözümlerinde Uygulama ve Dağıtım Bildirimleri

Sunucudaki Belgelerde Verilere Erişme

Aracılığıyla paylaş