CustomTaskPane.VisibleChanged Event

Reference

Definition

Namespace:: Microsoft.Office.Tools

Assemblies:: Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Occurs when the user displays or closes the custom task pane, or when code changes the value of the Visible property.

public:
 event EventHandler ^ VisibleChanged;

event EventHandler VisibleChanged;

member this.VisibleChanged : EventHandler

Event VisibleChanged As EventHandler

Event Type

EventHandler

Examples

The following code example demonstrates an event handler for the VisibleChanged event. This event handler updates the state of a toggle button on the Ribbon whenever the user opens or closes the custom task pane. This code example is part of a larger example provided in Walkthrough: Synchronizing a Custom Task Pane with a Ribbon Button.

private void taskPaneValue_VisibleChanged(object sender, System.EventArgs e)
{
    Globals.Ribbons.ManageTaskPaneRibbon.toggleButton1.Checked = 
        taskPaneValue.Visible;
}

Private Sub taskPaneValue_VisibleChanged(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles taskPaneValue.VisibleChanged

    Globals.Ribbons.ManageTaskPaneRibbon.ToggleButton1.Checked = taskPaneValue.Visible
End Sub

Remarks

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.

Applies to

Partager via