DataRepeaterAddRemoveItemsCancelEventArgs Class

Article
09/30/2015

Provides data for the DeletingItems and UserDeletingItems events.

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

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      Microsoft.VisualBasic.PowerPacks.DataRepeaterAddRemoveItemsCancelEventArgs

Syntax

public class DataRepeaterAddRemoveItemsCancelEventArgs : CancelEventArgs

public ref class DataRepeaterAddRemoveItemsCancelEventArgs : CancelEventArgs

type DataRepeaterAddRemoveItemsCancelEventArgs = 
    class
        inherit CancelEventArgs
    end

Public Class DataRepeaterAddRemoveItemsCancelEventArgs
    Inherits CancelEventArgs

Constructors

	Name	Description
	DataRepeaterAddRemoveItemsCancelEventArgs(Int32, Int32)	Initializes a new instance of the DataRepeaterAddRemoveItemsCancelEventArgs class.

Properties

	Name	Description
	Cancel	(Inherited from CancelEventArgs.)
	ItemCount	Gets the number of items being deleted.
	ItemIndex	Gets the index of the item that is being deleted.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

The DeletingItems and UserDeletingItems events occur when a request is made to delete a DataRepeaterItem from a DataRepeater control.

You can override the deletion by setting the cancel parameter of the DataRepeaterAddRemoveItemsCancelEventArgs to True.

Examples

The following example demonstrates how to cancel a deletion in the DeletingItems event handler.

private void DataRepeater1_DeletingItems(object sender, 
    Microsoft.VisualBasic.PowerPacks.DataRepeaterAddRemoveItemsCancelEventArgs e)
{
    // Check whether the user is a supervisor.

    ClientRolePrincipal rolePrincipal =
        System.Threading.Thread.CurrentPrincipal
        as ClientRolePrincipal;

    if (rolePrincipal.IsInRole("supervisor") == false)
    {
        e.Cancel = true;
        MessageBox.Show("You are not authorized to delete.");
    }
}

Private Sub DataRepeater1_DeletingItems(
    ByVal sender As Object, 
    ByVal e As Microsoft.VisualBasic.PowerPacks.DataRepeaterAddRemoveItemsCancelEventArgs
  ) Handles DataRepeater1.DeletingItems

    ' Check whether the user is a supervisor.
    If My.User.IsInRole("Supervisor") = False Then
        ' Cancel the deletion and display a message.
        e.Cancel = True
        MsgBox("You are not authorized to delete.")
    End If
End Sub

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.