Button.Delete Method

Definition

Namespace:

Microsoft.Office.Tools.Word.Controls

Assembly:

Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Deletes a dynamically created Button from the document and removes it from the ControlCollection.

public:
 void Delete();

public void Delete ();

member this.Delete : unit -> unit

Public Sub Delete ()

Examples

The following code example demonstrates a Button control that deletes itself when the user clicks it. The Click event handler of the button calls the Delete method to delete the button.

This example is for a document-level customization.

private void DeleteControl()
{
    Microsoft.Office.Tools.Word.Controls.Button deleteButton =
        this.Controls.AddButton(25, 75, 80, 30, "deleteButton");
    deleteButton.Text = "Click to delete";
    deleteButton.Click += new EventHandler(deleteButton_Click);
}

// Delete the clicked button.
void deleteButton_Click(object sender, EventArgs e)
{
    Microsoft.Office.Tools.Word.Controls.Button clickedButton =
        (Microsoft.Office.Tools.Word.Controls.Button)sender;

    clickedButton.Delete();
}

Private Sub DeleteControl()
    Dim DeleteButton As Microsoft.Office.Tools.Word.Controls.Button = _
        Me.Controls.AddButton(25, 75, 80, 30, "DeleteButton")
    DeleteButton.Text = "Click to delete"
    AddHandler DeleteButton.Click, AddressOf DeleteButton_Click
End Sub

' Delete the clicked button.
Private Sub DeleteButton_Click(ByVal sender As Object, ByVal e As EventArgs)
    Dim ClickedButton As Microsoft.Office.Tools.Word.Controls.Button = _
        CType(sender, Microsoft.Office.Tools.Word.Controls.Button)

    ClickedButton.Delete()
End Sub

Remarks

This method should only be used with a Button that is created programmatically at run time. An exception is thrown if you call this method on a Button that is added to the document at design time.