| SortableByPriorityCollection Class |
Represents an abstract parent for all MailBee collections sorted by
Priority value of their elements.
Inheritance HierarchySystemObject
System.CollectionsCollectionBase
MailBeeSortableByPriorityCollection
MailBee.DnsMXDnsServerCollection
MailBee.SmtpMailSmtpServerCollection
System.CollectionsCollectionBase
MailBeeSortableByPriorityCollection
MailBee.DnsMXDnsServerCollection
MailBee.SmtpMailSmtpServerCollection
Namespace: MailBee
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
SyntaxThe SortableByPriorityCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SortableByPriorityCollection | Initializes a new instance of the SortableByPriorityCollection class |
Methods| Name | Description | |
|---|---|---|
 | Clear | Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnClear | Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnClearComplete | Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsert | Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsertComplete | Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemove | Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemoveComplete | Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSet | Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSetComplete | Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnValidate | Performs additional custom processes when validating a value. (Inherited from CollectionBase.) |
| RemoveAt | Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.) |
| SortByPriority |
Sorts the items in the collection by their priority value.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
| Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
 | InnerList | Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
| List | Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
RemarksSorting by priority is used to sort DnsServer and SmtpServer objects in their corresponding collections so that servers with higher priority (also called preference) would be used first.
In send mail scenarios, having servers sorted by the priority value allows MailBee to send mails to high-priority servers while low priority servers are used as backup servers in the case if the primary servers fail.
See Also