Condividi tramite

Metodo CustomTaskPaneCollection.Add (UserControl, String)

  • Articolo

Crea un nuovo oggetto CustomTaskPane e lo aggiunge alla classe CustomTaskPaneCollection corrente. Il riquadro attività personalizzato è basato sulla classe UserControl specificata e ha il titolo specificato.

Spazio dei nomi:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Sintassi

'Dichiarazione
Function Add ( _
    control As UserControl, _
    title As String _
) As CustomTaskPane

CustomTaskPane Add(
    UserControl control,
    string title
)

Parametri

  • title
    Tipo: System.String
    Testo visualizzato nella barra del titolo del nuovo riquadro personalizzato.

Valore restituito

Tipo: Microsoft.Office.Tools.CustomTaskPane
Oggetto CustomTaskPane che rappresenta il nuovo riquadro attività personalizzato.

Eccezioni

Eccezione Condizione
ArgumentNullException

control o title è nullriferimento null (Nothing in Visual Basic).
ObjectDisposedException

Il metodo Dispose() è già stato chiamato nella classe CustomTaskPaneCollection.

Note

Utilizzare questo metodo per creare un nuovo oggetto CustomTaskPane associato alla finestra attiva dell'applicazione di Microsoft Office.

Benché un oggetto CustomTaskPaneCollection sia un insieme di oggetti CustomTaskPane, il metodo Add accetta oggetti UserControl anziché oggetti CustomTaskPane. Per ulteriori informazioni, vedere Cenni preliminari sui riquadri attività personalizzati.

Per specificare una determinata finestra ed eseguirne l'associazione a un riquadro attività personalizzato, utilizzare il metodo Add(UserControl, String, Object).

Esempi

Nell'esempio di codice seguente viene illustrato come creare un riquadro attività personalizzato utilizzando il metodo Add(UserControl, String). Nell'esempio vengono inoltre utilizzate proprietà dell'oggetto CustomTaskPane per modificare l'aspetto predefinito del riquadro attività personalizzato. Questo esempio di codice fa parte di un esempio più esaustivo fornito per 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);
}

Sicurezza di .NET Framework

Vedere anche

Riferimenti

CustomTaskPaneCollection Interfaccia

Overload Add

Spazio dei nomi Microsoft.Office.Tools