ServerDocument Sınıf

Makale
08/01/2011

Önbelleğe alınan verileri ve bir belge veya Visual Studio'da Office geliştirme araçları kullanılarak oluşturulmuş bir belge düzeyinde özelleştirme bir parçası olan çalışma kitabı özelleştirme bilgilere 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 belge tam yolunu kullanarak sınıf.
	ServerDocument(array<Byte[], String)	Yeni bir örneğini başlatır ServerDocument sınıfı kullanarak belgeye yüklenmiş olması temsil eden bir bayt dizisi ve dosya adı uzantısını belge.
	ServerDocument(Stream, String)	Yeni bir örneğini başlatır ServerDocument sınıfı kullanarak belgeye yüklenmiş olması temsil eden bir akış ve dosya adı uzantısını belge.
	ServerDocument(String, FileAccess)	Yeni bir örneğini başlatır ServerDocument sınıfını kullanarak belgeye yüklenmiş olması ve dosya erişimi için gösterir değeri tam yolubelge.

Üst

Özellikler

	Ad	Açıklama
	CachedData	Alır bir CachedData nesnesini temsil eden önbelleğe alınmış verileri içerdiği belge.
	DeploymentManifestUrl	Alır veya ayarlar belgeyle ilişkili özelleştirme için dağıtım bildirim URL'si.
	Document	Yüklenen bir bellek içi belge bayt dizisi alır ServerDocument.
	SolutionId	Bir GUID değerini alır Visual Studio Tools for Office çalışma zamanı modülü kullanır tanımlama çözümü.

Üst

Yöntemler

	Ad	Açıklama
	AddCustomization(String, Uri)	Bir özelleştirme, belirtilen derleme adı ve dağıtım bildirimi kullanarak belirtilen belgeye ekler.
	AddCustomization(String, String, Guid, Uri)	Bir özelleştirme, belirtilen belge, derleme adı, çözüm kimliği ve dağıtım listesi kullanarak belirtilen belgeye ekler.
	AddCustomization(String, String, Guid, Uri, Boolean, array<String[]%)	Altyapı.
	Close	Kapatır ServerDocument nesne.
	Equals	Belirler olup belirtilen Object eşittir geçerli Object. (Object kaynağından devralındı.)
	Finalize	Kaynakları boşaltın ve atık toplama işlemi tarafından iadesi önce diğer temizleme işlemleri gerçekleştirmek nesne izin verir. (Object kaynağından devralındı.)
	GetCustomizationVersion	Sürümünü döndürür Visual Studio Tools for Office çalışma zamanı modülü ile ilişkili özelleştirme oluşturmak için kullanılanbelirtilen belge.
	GetHashCode	Belirli bir tip için sağlama işlevini yerine getirir. (Object kaynağından devralındı.)
	GetType	Alır Type geçerli bir örneği. (Object kaynağından devralındı.)
	IsCacheEnabled	Belirtilen belge veri önbelleği sahip olup olmadığını gösteren bir değeri alır.
	IsCustomized	Belirtilen belge kullanılarak oluşturulmuş bir özelleştirme sahip olup olmadığını gösteren bir değeri alır Visual Studio 2010 Tools for Office Çalışma Zamanı Modülü.
	MemberwiseClone	Geçerli yüzeysel bir kopyasını oluşturur Object. (Object kaynağından devralındı.)
	RemoveCustomization	Özelleştirme belgeden kaldırır.
	Save	Kullanarak belgede yapılan değişiklikleri kaydeder ServerDocument sınıfa
	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

Açıklamalar

Use ServerDocument Excel yüklü olmayan bir bilgisayarda belge düzeyinde özelleştirmeleri belirli yönlerini sınıf veya Word'ün yüklü. Office ile konsol projeleri veya Windows Forms projeleri yerine gibi Office projeleri entegre olmayan uygulamalarda genellikle bu sınıfını kullanın.

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

Erişim ve bir sunucu üzerindeki belge veri önbelleği'deki verileri değiştirmek için kullanın CachedData özelliği.
Program aracılığıyla bir özelleştirme için bir belge veya bir özelleştirme bir belgeden kaldırmak için AddCustomization ve RemoveCustomization yöntemleri.
Erişmek veya belge ile ilgili dağıtım listesi URL'sini değiştirmek için DeploymentManifestUrl özelliği.

İki farklı sürümü vardır ServerDocument , sınıf Visual Studio 2010 Tools for Office Çalışma Zamanı Modülü. Kullanmanız gereken sürüm hedef bağlıdır.net Framework sınıfını kullanmak istediğiniz uygulamanın:

Hedef uygulamalar için .NET Framework 4, kullanma Microsoft.VisualStudio.Tools.Applications.ServerDocument sınıfı Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll derleme.
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 Sunucu Üzerinde Belge Yönetme.

Hangi kurucusunu kullanmak için seçme

Kullanmak için ServerDocument sınıf önbelleğe alınan veriler veya dağıtım listesi url bir belgede, oluşturmanız gerekir bir ServerDocument nesne.

İki adet vardır ServerDocument yapıcılar:

Bellekte açılmış olan bir belge erişmek için kullanabileceğiniz bir grup.
Diskte bir belgeyi erişmek için kullanabileceğiniz bir grup.

Bir belgenin belleğe erişme

Bellekte açılmış olan bir belgeye erişim için aşağıdaki oluşturucular birini kullanın:

Bu Kurucular bir bayt dizisi kabul veya bir Stream temsil eden belgede bellek. Bu önbelleğe alınan veriler veya uygulamayı değiştirmek istiyorsanız yararlıdır http protokolünü kullanarak bir hedef akış önce belgedeki bildirim. Bu Kurucular kullanmak için belge zaten bir özelleştirme olması gerekir; Aksi halde, bu bir yapıcılar yaratacak bir CannotLoadManifestException özel durum.

Diskteki belge erişme

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

Bu Kurucular, açmak istediğiniz belgeyi tam yolunu kabul eder. Varsayılan olarak, belge okuma/yazma erişimi ile açılır. Belge salt okunur veya salt yazılır erişimi ile 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 belge yükler ve özelleştirme için bağlı dağıtım listesi URL'sini görüntülerbelge.

Bu örnek aşağıdakileri gerektirir:

Bir konsol uygulaması projesi veya başka bir Office dışı projeye.
Aşağıdaki derlemelerine başvurular:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll ve Microsoft.VisualStudio.Tools.Applications.Runtime.dll (eğer proje .NET Framework 4'i hedefliyorsa).
  
  ya da
- Microsoft.Visualstudio.Tools.Applications.ServerDocument.V10.0.dll ve Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (, proje hedefleri.net Framework 3.5).
Imports(Visual Basic için) veya using (için C#) ifadeleri için Microsoft.VisualStudio.Tools.Applications ve Microsoft.VisualStudio.Tools.Applications.Runtime ad alanları üst kod dosyası.

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.