CustomTaskPane.Visible Property
Visual Studio 2012
Gets or sets a value that specifies whether the custom task pane is visible.
Assembly: Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)
| Exception | Condition |
|---|---|
| COMException | You try to set this property in the event handler for the DockPositionChanged or VisibleChanged event. |
| ObjectDisposedException | The 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 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); }
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
