DataRepeater.AllowUserToDeleteItems Property

 

Gets or sets a value that determines whether users can delete a row from a DataRepeater at run time.

Namespace:   Microsoft.VisualBasic.PowerPacks
Assembly:  Microsoft.VisualBasic.PowerPacks.Vs (in Microsoft.VisualBasic.PowerPacks.Vs.dll)

Syntax

public bool AllowUserToDeleteItems { get; set; }

public:
property bool AllowUserToDeleteItems {
    bool get();
    void set(bool value);
}

member AllowUserToDeleteItems : bool with get, set

Public Property AllowUserToDeleteItems As Boolean

Property Value

Type: System.Boolean

true if the user can delete rows; otherwise false. The default is true.

Remarks

When the AllowUserToDeleteItems property is set to True, users can delete rows by clicking the BindingNavigatorDeleteItem ToolStripButton on the BindingNavigator control, or by pressing DELETE when a DataRepeaterItem has focus.

When the AllowUserToDeleteItems property is set to False, the DELETE keyboard function is disabled, but the BindingNavigatorDeleteItem ToolStripButton is still enabled. If you want to prevent users from deleting rows, you should also disable or remove the BindingNavigatorDeleteItem ToolStripButton on the BindingNavigator control.

Examples

The following code example demonstrates how to disable the Delete ToolStripButton button when the AllowUserToAddItems property is set to False. It assumes that you have a form that contains a DataRepeater control named DataRepeater1 and a BindingNavigator control.

private void dataRepeater1_AllowUserToDeleteItemsChanged(object sender, System.EventArgs e)
{
    // If this event occurs during form initialization, exit.
    if (this.IsHandleCreated == false) { return; }
    // If AllowUserToDeleteItems is False.
    if (dataRepeater1.AllowUserToDeleteItems == false)
    // Disable the Delete button.
    {
        bindingNavigatorDeleteItem.Enabled = false;
    }
    else
    {
        // Otherwise, enable the Delete button.
        bindingNavigatorDeleteItem.Enabled = true;
    }
}
private void bindingNavigatorDeleteItem_EnabledChanged(object sender, System.EventArgs e)
{
    if (dataRepeater1.AllowUserToDeleteItems == false)
    // The BindingSource resets this property when a 
    // new record is selected, so override it.
    {
        if (bindingNavigatorDeleteItem.Enabled == true)
        {
            bindingNavigatorDeleteItem.Enabled = false;
        }
    }
}

Private Sub DataRepeater1_AllowUserToDeleteItemsChanged(
    ) Handles DataRepeater1.AllowUserToDeleteItemsChanged

    ' If this event occurs during form initialization, exit.
    If Me.IsHandleCreated = False Then Exit Sub
    ' If AllowUserToDeleteItems is False.
    If DataRepeater1.AllowUserToDeleteItems = False Then
        ' Disable the Delete button.
        BindingNavigatorDeleteItem.Enabled = False
    Else
        ' Otherwise, enable the Delete button.
        BindingNavigatorDeleteItem.Enabled = True
    End If
End Sub
Private Sub BindingNavigatorDeleteItem_EnabledChanged(
    ) Handles BindingNavigatorDeleteItem.EnabledChanged

    If DataRepeater1.AllowUserToDeleteItems = False Then
        ' The BindingSource resets this property when a 
        ' new record is selected, so override it.
        If BindingNavigatorDeleteItem.Enabled = True Then
            BindingNavigatorDeleteItem.Enabled = False
        End If
    End If
End Sub

See Also

DataRepeater Class
Microsoft.VisualBasic.PowerPacks Namespace
Introduction to the DataRepeater Control (Visual Studio)
How to: Disable Adding and Deleting DataRepeater Items (Visual Studio)

Return to top