CustomTaskPane Arabirim

Makale
02/17/2014

Bir Microsoft Office uygulamasında özel görev bölmesi temsil eder.

Ad alanı: Microsoft.Office.Tools
Derlemeler:   Microsoft.Office.Tools.Common.v4.0.Utilities (Microsoft.Office.Tools.Common.v4.0.Utilities.dll içinde)
  Microsoft.Office.Tools.Outlook.v4.0.Utilities (Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll içinde)
  Microsoft.Office.Tools.Excel.v4.0.Utilities (Microsoft.Office.Tools.Excel.v4.0.Utilities.dll içinde)
  Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll içinde)
  Microsoft.Office.Tools.Word.v4.0.Utilities (Microsoft.Office.Tools.Word.v4.0.Utilities.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 , özel görev bölmesinin kullanıcı arabirimini sağlar.
	DockPosition	Alır veya ilişkili uygulama penceresi özel görev bölmesini bulunduğu belirten bir değeri ayarlar.
	DockPositionRestrict	Alır veya belirtilen konumda yerleşik özel görev bölmesini 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 olup olmadığını belirten bir değeri ayarlar.
	Width	Alır veya punto özel görev bölmesinin genişliğini ayarlar.
	Window	Özel görev bölmesinin ilişkili belge penceresini alır.

Üst

Yöntemler

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

Üst

Olaylar

	Ad	Açıklama
	DockPositionChanged	Kullanıcı özel görev bölmesini stok konumunu değiştirdiğinde veya kod değeri değiştiğinde oluşur DockPosition özelliği.
	VisibleChanged	Kullanıcı özel görev bölmesini kapatır veya görüntüler veya kod değeri değiştiğinde oluşur Visible özelliği.

Üst

Notlar

Kullanım bir CustomTaskPane nesne bir uygulama düzeyi eklentisinde özel görev bölmesini değiştirmek veya konumu veya özel görev bölmesinin görünürlüğünü değiştirdiğinde yanıt vermek için.Görev bölmeleri, genellikle uygulama penceresinin bir tarafına yerleştirilmiş kullanıcı arabirimi panelleridir.Özel görev bölmelerini oluşturma hakkında daha fazla bilgi için bkz: Özel Görev Bölmeleri.

Özel görev bölmesinin konumunu ve boyutunu denetlemek için Özellikler gibi kullanabilirsiniz Height, Width, ve Visible.

Özel görev bölmesini taşır veya görünürlük değiştirir yanıt verecek işleyebilir 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 Çalışma Zamanı İçin Visual Studio Araçlarına Genel Bakış.

Kullanım

Bu belgelerde, .NET Framework 4 ve .NET Framework 4.5'i hedefleyen Office projelerinde 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 kullanarak özel görev bölmesi oluşturmak nasıl gösterir Add(UserControl, String) yöntem.Örnek özelliklerini kullanır CustomTaskPane özel görev bölmesini varsayılan görünümünü ayarlamak için nesne ve için bir olay işleyicisi tanımlar DockPositionChanged olay.Bu örnek derlemek için içine kodu kopyalayın ThisAddIn eklenti projesinde özel görev bölmelerini destekleyen bir uygulama için sınıf.Varsayılan yerine ThisAddIn_Startup yönteminde ThisAddIn ile sınıf ThisAddIn_Startup yöntem bu örnekte.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;
        }
    }
}