CustomTaskPane.Visible Property

 

Gets or sets a value that specifies whether the custom task pane is visible.

Namespace:   Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Property Visible As Boolean

Property Value

Type: System.Boolean

true if the custom task pane is visible; otherwise, false. The default is false.

Exception Condition
COMException

You try to set this property in the event handler for the DockPositionChanged or VisibleChanged event.

ObjectDisposedException

The M:Microsoft.Office.Tools.CustomTaskPane.Dispose method of the CustomTaskPane has already been called.

Microsoft Office applications do not provide a default UI for users to display custom task panes. If you create a custom task pane in your add-in, you should also create a UI element, such as a button, that users can click to display or hide your custom task pane. For more information, see Custom Task Panes.

The following code example creates a custom task pane and displays it. This code example is part of a larger example provided for 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
Return to top
Show: