CustomTaskPane.Visible プロパティ (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 Visible As Boolean
'使用
Dim instance As CustomTaskPane
Dim value As Boolean

value = instance.Visible

instance.Visible = value

public bool Visible { get; set; }

プロパティ値

型 : System.Boolean

カスタム作業ウィンドウを表示する場合は true、それ以外の場合は false。既定値は false です。

例外

例外	条件
COMException	DockPositionChanged イベントまたは VisibleChanged イベントのイベントハンドラで、このプロパティを設定しようとしています。
ObjectDisposedException	CustomTaskPane の Dispose メソッドは既に呼び出されています。

解説

2007 Microsoft Office system のアプリケーションには、ユーザーがカスタム作業ウィンドウを表示するための既定の UI が用意されていません。アドインでカスタム作業ウィンドウを作成する場合は、ボタンなどの UI 要素も作成して、ユーザーがクリックすればカスタム作業ウィンドウの表示と非表示を切り替えることができるようにする必要があります。詳細については、「カスタム作業ウィンドウの概要」を参照してください。

例

次のコード例では、カスタム作業ウィンドウを作成して表示します。このコード例は、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);
}