CustomTaskPane Arabirim

Makale
08/01/2011

Bir Microsoft Office uygulamasında bir özel görev bölmesini gösterir.

Ad alanı: Microsoft.Office.Tools
Derleme: Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll içinde)

Sözdizimi

'Bildirim
<GuidAttribute("881b42fd-484d-4494-8500-779de4e4aac1")> _
Public Interface CustomTaskPane _
    Inherits IDisposable

[GuidAttribute("881b42fd-484d-4494-8500-779de4e4aac1")]
public interface CustomTaskPane : IDisposable

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

Özellikler

	Ad	Açıklama
	Control	Alır UserControl sağlayan kullanıcı arabirimi, özel görev bölmesi.
	DockPosition	Alır veya özel görev bölmesi uygulama penceresine göre bulunduğu belirten bir değeri ayarlar.
	DockPositionRestrict	Alır veya belirtilen konumu sabitlenmiş özel görev bölmesi engelleyen bir değer ayarlar.
	Height	Alır veya noktalar özel görev bölmesinin yüksekliğini ayarlar.
	Title	Özel görev bölmesinin başlık alır.
	Visible	Alır veya özel görev bölmesi görünür durumda olup olmadığını belirten bir değeri ayarlar.
	Width	Alır veya noktalar, özel görev bölmesinin genişliğini ayarlar.
	Window	Özel görev bölmesini ilişkili belge penceresi alır.

Üst

Yöntemler

	Ad	Açıklama
	Dispose	Boşaltma, serbest bırakma veya yönetilmeyen kaynakları sıfırlama ile ilişkilendirilmiş uygulama tanımlı görevleri gerçekleştirir. (IDisposable kaynağından devralındı.)

Üst

Olaylar

	Ad	Açıklama
	DockPositionChanged	Kullanıcıya özel görev bölmesi geçici stok konumunu değiştirir veya kod değeri değiştiğinde oluşur DockPosition özelliği.
	VisibleChanged	Kullanıcı görüntüler veya özel görev bölmesi kapanır veya kod değeri değiştiğinde oluşur Visible özelliği.

Üst

Açıklamalar

Kullanımı bir CustomTaskPane bir uygulama düzeyinde eklentisi bir özel görev bölmesini değiştirmek veya yanıt nesnesinde, konum veya özel görev bölmesi değişiklikler. görünürlüğünü Görev bölmeleri, genellikle bir uygulama penceresinin bir tarafında yuvaya kullanıcı arabirimi panellerini sunulmuştur. Özel görev bölmeleri oluşturma hakkında daha fazla bilgi için bkz: Özel Görev Bölmelerine Genel Bakış.

Boyut veya özel görev bölmesi konumunu denetlemek için özellikler gibi kullanabileceğiniz Height, Width, ve Visible.

Özel görev bölmesini taşır veya görünürlük değişiklikleri yanıtlamak için ele DockPositionChanged ve VisibleChanged olayları.

Not

Bu arabirim Office için Visual Studio Araçları çalışma zamanı modülü tarafından uygulanır. Kodunuzda gerçekleştirilmesi amaçlanmamıştır. Daha fazla bilgi için bkz: Office için Visual Studio Araçları Çalışma Zamanına Genel Bakış.

Kullanım

Bu belgelerde, .NET Framework 4'ü hedefleyen projelerde kullanılan bu türün sürümü açıklanır. .NET Framework 3.5'i hedefleyen projelerde, bu türün üyeleri farklı olabilir ve bu tür için sağlanan kod örnekleri çalışmayabilir. .NET Framework 3.5'i hedefleyen projelerde bu tür hakkındaki belgeler için, Visual Studio 2008 belgelerinde aşağıdaki başvuru bölümüne bakın: https://go.microsoft.com/fwlink/?LinkId=160658.

Örnekler

Aşağıdaki kod örneği, bir özel görev bölmesini kullanarak oluşturmak gösterilmiştir Add(UserControl, String) yöntemi. Örnek özelliklerini kullanır CustomTaskPane özel görev bölmesi varsayılan görünümünü ayarlamak için nesne ve bir olay işleyicisini tanımlar DockPositionChanged olay. Bu örnek derlemek için içine kodu kopyalayın ThisAddIn sınıfında bir eklenti projesi, uygulamaya destekleyen özel görev bölmeleri. Varsayılan değiştirmek ThisAddIn_Startup yönteminde ThisAddIn ile sınıf ThisAddIn_Startup yöntemi Bu örnek. Bu örnek, ayrıca proje içerdiğini varsayar bir UserControl adlı MyUserControlve UserControl içeren bir FlowLayoutPanel adlı FlowPanel.

Private myUserControl1 As MyUserControl
Private WithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane

Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

    myUserControl1 = New MyUserControl()
    myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "New Task Pane")

    With myCustomTaskPane
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionFloating
        .Height = 500
        .Width = 500
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionRight
        .Width = 300
        .Visible = True
    End With
End Sub

Private Sub myCustomTaskPane_DockPositionChanged(ByVal sender As Object, _
    ByVal e As EventArgs) Handles myCustomTaskPane.DockPositionChanged

    Dim taskPane As Microsoft.Office.Tools.CustomTaskPane = _
        TryCast(sender, Microsoft.Office.Tools.CustomTaskPane)

    If taskPane IsNot Nothing Then

        ' Adjust sizes of user control and flow panel to fit current task pane size.
        Dim userControl As MyUserControl = TryCast(taskPane.Control, MyUserControl)
        Dim paneSize As System.Drawing.Size = _
            New System.Drawing.Size(taskPane.Width, taskPane.Height)
        userControl.Size = paneSize
        userControl.FlowPanel.Size = paneSize

        ' Adjust flow direction of controls on the task pane.
        If taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionTop Or _
            taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom Then

            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.LeftToRight
        Else
            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.TopDown
        End If
    End If
End Sub

private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    myUserControl1 = new MyUserControl();
    myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1,
        "New Task Pane");

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionFloating;
    myCustomTaskPane.Height = 500;
    myCustomTaskPane.Width = 500;

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionRight;
    myCustomTaskPane.Width = 300;

    myCustomTaskPane.Visible = true;
    myCustomTaskPane.DockPositionChanged +=
        new EventHandler(myCustomTaskPane_DockPositionChanged);
}

private void myCustomTaskPane_DockPositionChanged(object sender, EventArgs e)
{
    Microsoft.Office.Tools.CustomTaskPane taskPane =
        sender as Microsoft.Office.Tools.CustomTaskPane;

    if (taskPane != null)
    {
        // Adjust sizes of user control and flow panel to fit current task pane size.
        MyUserControl userControl = taskPane.Control as MyUserControl;
        System.Drawing.Size paneSize = new System.Drawing.Size(taskPane.Width, taskPane.Height);
        userControl.Size = paneSize;
        userControl.FlowPanel.Size = paneSize;

        // Adjust flow direction of controls on the task pane.
        if (taskPane.DockPosition == 
            Office.MsoCTPDockPosition.msoCTPDockPositionTop ||
            taskPane.DockPosition ==
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom)
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.LeftToRight;
        }
        else
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.TopDown;
        }
    }
}