Application.DeleteControl method (Access)

The DeleteControl method deletes a specified control from a form.

Syntax

expression.DeleteControl (FormName, ControlName)

expression A variable that represents an Application object.

Parameters

Name Required/Optional Data type Description
FormName Required String The name of the form containing the control that you want to delete.
ControlName Required String The name of the control that you want to delete.

Return value

Nothing

Remarks

For example, suppose you have a procedure that must be run the first time each user signs in to your database. You can set the OnClick property of a button on the form to this procedure. After the user has signed in and run the procedure, you can use the DeleteControl method to dynamically remove the command button from the form.

The DeleteControl method is available only in form Design view or report Design view, respectively.

Note

If you are building a wizard that deletes a control from a form or report, your wizard must open the form or report in Design view before it can delete the control.

Example

The following example creates a form with a command button and displays a message that asks if the user wants to delete the command button. If the user chooses Yes, the command button is deleted.

Sub DeleteCommandButton() 
 Dim frm As Form, ctlNew As Control 
 Dim strMsg As String, intResponse As Integer, _ 
 intDialog As Integer 
 
 ' Create new form and get pointer to it. 
 Set frm = CreateForm 
 ' Create new command button. 
 Set ctlNew = CreateControl(frm.Name, acCommandButton) 
 ' Restore form. 
 DoCmd.Restore 
 ' Set caption. 
 ctlNew.Caption = "New Command Button" 
 ' Size control. 
 ctlNew.SizeToFit 
 ' Prompt user to delete control. 
 strMsg = "About to delete " & ctlNew.Name &". Continue?" 
 ' Define buttons to be displayed in dialog box. 
 intDialog = vbYesNo + vbCritical + vbDefaultButton2 
 intResponse = MsgBox(strMsg, intDialog) 
 If intResponse = vbYes Then 
 ' Delete control. 
 DeleteControl frm.Name, ctlNew.Name 
 End If 
End Sub

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.