CustomTaskPane.DockPosition プロパティ (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

アプリケーションウィンドウを基準としたカスタム作業ウィンドウの配置場所を指定する値を取得または設定します。

名前空間 : Microsoft.Office.Tools
アセンブリ : Microsoft.Office.Tools.Common.v9.0 (Microsoft.Office.Tools.Common.v9.0.dll 内)

構文

'宣言
Public Property DockPosition As MsoCTPDockPosition
'使用
Dim instance As CustomTaskPane
Dim value As MsoCTPDockPosition

value = instance.DockPosition

instance.DockPosition = value

public MsoCTPDockPosition DockPosition { get; set; }

プロパティ値

型 : Microsoft.Office.Core.MsoCTPDockPosition

Microsoft.Office.Core.MsoCTPDockPosition 値の 1 つ。既定値は Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight です。

例外

例外	条件
ObjectDisposedException	CustomTaskPane の Dispose メソッドは既に呼び出されています。
COMException	DockPosition プロパティの値を変更する場合、DockPositionRestrict プロパティの値は Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange です。または DockPositionChanged イベントまたは VisibleChanged イベントのイベントハンドラで、このプロパティを設定しようとしています。

ObjectDisposedException

CustomTaskPane の Dispose メソッドは既に呼び出されています。

COMException

DockPosition プロパティの値を変更する場合、DockPositionRestrict プロパティの値は Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange です。

または

DockPositionChanged イベントまたは VisibleChanged イベントのイベントハンドラで、このプロパティを設定しようとしています。

解説

次の表に Microsoft.Office.Core.MsoCTPDockPosition 列挙型の値を示します。

Value	説明
msoCTPDockPositionLeft	カスタム作業ウィンドウをウィンドウの左端にドッキングします。
msoCTPDockPositionTop	カスタム作業ウィンドウをウィンドウの上端にドッキングします。
msoCTPDockPositionRight	カスタム作業ウィンドウをウィンドウの右端にドッキングします。
msoCTPDockPositionBottom	カスタム作業ウィンドウをウィンドウの下端にドッキングします。
msoCTPDockPositionFloating	ウィンドウの前面にカスタム作業ウィンドウを表示します。ユーザーは作業ウィンドウをウィンドウ内の任意の場所にドラッグできます。

例

次のコード例では、カスタム作業ウィンドウを作成し、アクティブなアプリケーションウィンドウの前面に表示される場合とドッキングされる場合とで異なる既定サイズが適用されるように設定しています。このコード例は、CustomTaskPane クラスのトピックで取り上げているコード例の一部分です。

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