Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The ClearCollection<T> activity designer is used to create and configure a ClearCollection activity.
The ClearCollection<T> Activity
The ClearCollection activity clears a specified collection of all items.
Using the ClearCollection<T> Activity Designer
The ClearCollection<T> activity designer can be found in the Collection category of the Toolbox, which is accessed by clicking the Toolbox tab of the Workflow Designer (Alternatively, select Toolbar from the View menu or CTRL+ALT+X.)
The ClearCollection<T> activity designer can be dragged from the Toolbox and dropped on to the Workflow Designer surface wherever activities are usually placed, such as inside a Sequence. This creates a ClearCollection activity with a default DisplayName of ClearCollection<Int32>. (By default, the TypeArgument is Int32. This can be changed in the property grid.) The DisplayName value can be edited in the header of the ClearCollection<T> activity designer or in the DisplayName box of the property grid. The other properties must be edited on the property grid.
The ClearCollection<T> Properties
The following table shows the ClearCollection properties and describes how they are used in the designer.
Property Name | Required | Usage |
---|---|---|
False |
Specifies the optional friendly name of the ClearCollection activity. The default is ClearCollection<Int32>. Although the DisplayName value is not strictly required, it is a best practice to use one. |
|
True |
Specifies the collection to be cleared of items. This collection is of type ICollection<TypeArgument>. To specify the collection, type a Visual Basic expression in the property grid. |
|
TypeArgument |
True |
Specifies the type T of the items contained in the ICollection. By default, this TypeArgument type is set to Int32. To change the type, change the value of the TypeArgument in the combo box in the property grid. |
See Also
Concepts
AddToCollection<T> Activity Designer
ExistsInCollection<T> Activity Designer
RemoveFromCollection<T> Activity Designer