Click or drag to resize
Sandcastle Help File BuilderVersionSettingsCollection Class
This collection class is used to hold the version settings information for the VersionBuilderPlugIn.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionVersionSettings
    System.ComponentModelBindingListVersionSettings
      SandcastleBuilder.PlugInsVersionSettingsCollection

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2014.11.22.0
Syntax
public class VersionSettingsCollection : BindingList<VersionSettings>

The VersionSettingsCollection type exposes the following members.

Constructors
  NameDescription
Public methodVersionSettingsCollection
Initializes a new instance of the VersionSettingsCollection class
Top
Methods
  NameDescription
Public methodAdd (Inherited from CollectionVersionSettings.)
Public methodAddNew
Adds a new item to the collection.
(Inherited from BindingListVersionSettings.)
Protected methodAddNewCore
Adds a new item to the end of the collection.
(Inherited from BindingListVersionSettings.)
Protected methodApplySortCore
Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingListVersionSettings.)
Public methodCancelNew
Discards a pending new item.
(Inherited from BindingListVersionSettings.)
Public methodClear (Inherited from CollectionVersionSettings.)
Protected methodClearItems
Removes all elements from the collection.
(Inherited from BindingListVersionSettings.)
Public methodContains (Inherited from CollectionVersionSettings.)
Public methodCopyTo (Inherited from CollectionVersionSettings.)
Public methodEndNew
Commits a pending new item to the collection.
(Inherited from BindingListVersionSettings.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFindCore
Searches for the index of the item that has the specified property descriptor with the specified value, if searching is implemented in a derived class; otherwise, a NotSupportedException.
(Inherited from BindingListVersionSettings.)
Public methodFromXml
This is used to load the version settings list from the configuration settings.
Public methodGetEnumerator (Inherited from CollectionVersionSettings.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT.
(Inherited from CollectionVersionSettings.)
Public methodInsert (Inherited from CollectionVersionSettings.)
Protected methodInsertItem
Inserts the specified item in the list at the specified index.
(Inherited from BindingListVersionSettings.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from BindingListVersionSettings.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from BindingListVersionSettings.)
Public methodRemove (Inherited from CollectionVersionSettings.)
Public methodRemoveAt (Inherited from CollectionVersionSettings.)
Protected methodRemoveItem
Removes the item at the specified index.
(Inherited from BindingListVersionSettings.)
Protected methodRemoveSortCore
Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingListVersionSettings.)
Public methodResetBindings
Raises a ListChanged event of type Reset.
(Inherited from BindingListVersionSettings.)
Public methodResetItem
Raises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingListVersionSettings.)
Protected methodSetItem
Replaces the item at the specified index with the specified item.
(Inherited from BindingListVersionSettings.)
Public methodSort
This is used to sort the collection by framework label in ascending order and by version in descending order.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToXml
This is used to save the version settings list to the configuration settings.
Top
Properties
  NameDescription
Public propertyAllowEdit
Gets or sets a value indicating whether items in the list can be edited.
(Inherited from BindingListVersionSettings.)
Public propertyAllowNew
Gets or sets a value indicating whether you can add items to the list using the AddNew method.
(Inherited from BindingListVersionSettings.)
Public propertyAllowRemove
Gets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingListVersionSettings.)
Public propertyCount (Inherited from CollectionVersionSettings.)
Protected propertyIsSortedCore
Gets a value indicating whether the list is sorted.
(Inherited from BindingListVersionSettings.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionVersionSettings.)
Protected propertyItems (Inherited from CollectionVersionSettings.)
Public propertyRaiseListChangedEvents
Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingListVersionSettings.)
Protected propertySortDirectionCore
Gets the direction the list is sorted.
(Inherited from BindingListVersionSettings.)
Protected propertySortPropertyCore
Gets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns null.
(Inherited from BindingListVersionSettings.)
Protected propertySupportsChangeNotificationCore
Gets a value indicating whether ListChanged events are enabled.
(Inherited from BindingListVersionSettings.)
Protected propertySupportsSearchingCore
Gets a value indicating whether the list supports searching.
(Inherited from BindingListVersionSettings.)
Protected propertySupportsSortingCore
Gets a value indicating whether the list supports sorting.
(Inherited from BindingListVersionSettings.)
Top
Events
  NameDescription
Public eventAddingNew
Occurs before an item is added to the list.
(Inherited from BindingListVersionSettings.)
Public eventListChanged
Occurs when the list or an item in the list changes.
(Inherited from BindingListVersionSettings.)
Top
See Also