EWSoftware.PDI Namespace Documentation
VNote
A type-safe collection of VNote objects
Definition
Namespace: EWSoftware.PDI.Objects
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
C#
[SerializableAttribute]
public class VNoteCollection : ExtendedBindingList<VNote>VB
<SerializableAttribute>
Public Class VNoteCollection
Inherits ExtendedBindingList(Of VNote)C++
[SerializableAttribute]
public ref class VNoteCollection : public ExtendedBindingList<VNote^>F#
[<SerializableAttribute>]
type VNoteCollection =
class
inherit ExtendedBindingList<VNote>
end- Inheritance
- Object CollectionVNote BindingListVNote ExtendedBindingListVNote VNoteCollection
Remarks
The class has a type-safe enumerator and is serializable
Constructors
| VNoteCollection | Default constructor |
| VNoteCollection(IListVNote) | Construct the collection using a list of VNote objects |
Properties
| AllowEdit | Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListVNote) |
| AllowNew | Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListVNote) |
| AllowRemove | Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListVNote) |
| Count | Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionVNote) |
| IsSortedCore |
This returns a flag indicating whether or not sorting is currently applied
(Inherited from ExtendedBindingListT) |
| ItemInt32 | Gets or sets the element at the specified index. (Inherited from CollectionVNote) |
| ItemString | Collection indexer |
| Items | Gets a IListT wrapper around the CollectionT. (Inherited from CollectionVNote) |
| RaiseListChangedEvents | Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListVNote) |
| SortDirectionCore |
This returns the current sort direction if sorting has been applied
(Inherited from ExtendedBindingListT) |
| SortPropertyCore |
This returns the current property descriptor if sorting has been applied
(Inherited from ExtendedBindingListT) |
| SupportsChangeNotificationCore | Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListVNote) |
| SupportsSearchingCore |
This is used to indicate whether or not searching is supported
(Inherited from ExtendedBindingListT) |
| SupportsSortingCore |
This is used to indicate whether or not sorting is supported
(Inherited from ExtendedBindingListT) |
| SyncRoot |
This returns an object that can be used to synchronize access to the collection
(Inherited from ExtendedBindingListT) |
Methods
| Add | Adds an object to the end of the CollectionT. (Inherited from CollectionVNote) |
| AddNew | Adds a new item to the collection. (Inherited from BindingListVNote) |
| AddNewCore | Adds a new item to the end of the collection. (Inherited from BindingListVNote) |
| AddRange |
Add a range of items from an array
(Inherited from ExtendedBindingListT) |
| ApplySortCore |
This is overridden to apply a sort based on the selected property descriptor and sort direction
(Inherited from ExtendedBindingListT) |
| AssignUniqueIds | This can be used to ensure that all vNotes in the collection have a unique ID assigned to them |
| CancelNew | Discards a pending new item. (Inherited from BindingListVNote) |
| Clear | Removes all elements from the CollectionT. (Inherited from CollectionVNote) |
| ClearItems | Removes all elements from the collection. (Inherited from BindingListVNote) |
| CloneRange |
Clone and add a range of items from an enumerable list of items
(Inherited from ExtendedBindingListT) |
| Contains | Determines whether an element is in the CollectionT. (Inherited from CollectionVNote) |
| CopyTo | Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionVNote) |
| EndNew | Commits a pending new item to the collection. (Inherited from BindingListVNote) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Exists |
Determine whether or not the collection contains at least one item that matches the conditions in the
specified predicate.
(Inherited from ExtendedBindingListT) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Find |
Search the collection for the first item that matches the conditions in the specified predicate
(Inherited from ExtendedBindingListT) |
| FindAll |
Retrieve all of the items that match the conditions defined by the specified predicate
(Inherited from ExtendedBindingListT) |
| FindCore |
This searches for the index of the item that has the specified property descriptor with the specified
value.
(Inherited from ExtendedBindingListT) |
| FindIndex(PredicateT) |
Search for the first item that matches the conditions defined by the specified predicate and return
its zero-based index.
(Inherited from ExtendedBindingListT) |
| FindIndex(Int32, PredicateT) |
Search for the first item that matches the conditions defined by the specified predicate between the
starting index and the end of the collection and return its zero-based index.
(Inherited from ExtendedBindingListT) |
| FindIndex(Int32, Int32, PredicateT) |
Search for the first item that matches the conditions defined by the specified predicate between the
starting index and the given number of items and return its zero-based index.
(Inherited from ExtendedBindingListT) |
| FindLast |
Search the collection for the last item that matches the conditions in the specified predicate
(Inherited from ExtendedBindingListT) |
| FindLastIndex(PredicateT) |
Search for the last item that matches the conditions defined by the specified predicate and return
its zero-based index.
(Inherited from ExtendedBindingListT) |
| FindLastIndex(Int32, PredicateT) |
Search for the last item that matches the conditions defined by the specified predicate between the
starting index and searching backwards to the start of the collection and return its zero-based
index.
(Inherited from ExtendedBindingListT) |
| FindLastIndex(Int32, Int32, PredicateT) |
Search for the last item that matches the conditions defined by the specified predicate between the
starting index and searching backwards for the given number of items and return its zero-based
index.
(Inherited from ExtendedBindingListT) |
| ForEach |
Performs the specified action on each item in the collection
(Inherited from ExtendedBindingListT) |
| GetEnumerator | Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionVNote) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IndexOf | Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT. (Inherited from CollectionVNote) |
| Insert | Inserts an element into the CollectionT at the specified index. (Inherited from CollectionVNote) |
| InsertItem | Inserts the specified item in the list at the specified index. (Inherited from BindingListVNote) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAddingNew | Raises the AddingNew event. (Inherited from BindingListVNote) |
| OnListChanged | Raises the ListChanged event. (Inherited from BindingListVNote) |
| PropagateVersion | This can be used to propagate a version to all members of the collection |
| Remove | Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionVNote) |
| RemoveAll |
Remove all items that match the conditions defined by the specified predicate
(Inherited from ExtendedBindingListT) |
| RemoveAt | Removes the element at the specified index of the CollectionT. (Inherited from CollectionVNote) |
| RemoveItem | Removes the item at the specified index. (Inherited from BindingListVNote) |
| RemoveRange |
Remove the specified range of items from the collection
(Inherited from ExtendedBindingListT) |
| RemoveSortCore |
This is used to remove the sort
(Inherited from ExtendedBindingListT) |
| ResetBindings | Raises a ListChanged event of type Reset. (Inherited from BindingListVNote) |
| ResetItem | Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListVNote) |
| SetItem | Replaces the item at the specified index with the specified item. (Inherited from BindingListVNote) |
| Sort |
Sort the items in the collection using the default comparer
(Inherited from ExtendedBindingListT) |
| Sort(ComparisonT) |
Sort the items in the collection using the specified ComparisonT delegate
(Inherited from ExtendedBindingListT) |
| Sort(IComparerT) |
Sort the items in the collection using the specified comparer
(Inherited from ExtendedBindingListT) |
| ToString |
This can be used to convert an entire collection of vNotes to their string form
(Overrides ObjectToString) |
| TrueForAll |
Determine if every item in the collection matches the conditions defined by the specified predicate
(Inherited from ExtendedBindingListT) |
| WriteToStream | This can be used to write an entire collection of vNotes to a PDI data stream |
Events
| AddingNew | Occurs before an item is added to the list. (Inherited from BindingListVNote) |
| ListChanged | Occurs when the list or an item in the list changes. (Inherited from BindingListVNote) |