Click or drag to resize
Sandcastle Help File BuilderReferenceLinkSettingsCollection Class
This collection class is used to hold the reference link settings information for the AdditionalReferenceLinksPlugIn.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionReferenceLinkSettings
    System.ComponentModelBindingListReferenceLinkSettings
      SandcastleBuilder.PlugInsReferenceLinkSettingsCollection

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

The ReferenceLinkSettingsCollection type exposes the following members.

Constructors
  NameDescription
Public methodReferenceLinkSettingsCollection
Initializes a new instance of the ReferenceLinkSettingsCollection class
Top
Methods
  NameDescription
Public methodAdd (Inherited from CollectionReferenceLinkSettings.)
Public methodAddNew
Adds a new item to the collection.
(Inherited from BindingListReferenceLinkSettings.)
Protected methodAddNewCore
Adds a new item to the end of the collection.
(Inherited from BindingListReferenceLinkSettings.)
Protected methodApplySortCore
Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingListReferenceLinkSettings.)
Public methodCancelNew
Discards a pending new item.
(Inherited from BindingListReferenceLinkSettings.)
Public methodClear (Inherited from CollectionReferenceLinkSettings.)
Protected methodClearItems
Removes all elements from the collection.
(Inherited from BindingListReferenceLinkSettings.)
Public methodContains (Inherited from CollectionReferenceLinkSettings.)
Public methodCopyTo (Inherited from CollectionReferenceLinkSettings.)
Public methodEndNew
Commits a pending new item to the collection.
(Inherited from BindingListReferenceLinkSettings.)
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 BindingListReferenceLinkSettings.)
Public methodFromXml
This is used to load the reference link settings list from the configuration settings.
Public methodGetEnumerator (Inherited from CollectionReferenceLinkSettings.)
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 CollectionReferenceLinkSettings.)
Public methodInsert (Inherited from CollectionReferenceLinkSettings.)
Protected methodInsertItem
Inserts the specified item in the list at the specified index.
(Inherited from BindingListReferenceLinkSettings.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from BindingListReferenceLinkSettings.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from BindingListReferenceLinkSettings.)
Public methodRemove (Inherited from CollectionReferenceLinkSettings.)
Public methodRemoveAt (Inherited from CollectionReferenceLinkSettings.)
Protected methodRemoveItem
Removes the item at the specified index.
(Inherited from BindingListReferenceLinkSettings.)
Protected methodRemoveSortCore
Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingListReferenceLinkSettings.)
Public methodResetBindings
Raises a ListChanged event of type Reset.
(Inherited from BindingListReferenceLinkSettings.)
Public methodResetItem
Raises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingListReferenceLinkSettings.)
Protected methodSetItem
Replaces the item at the specified index with the specified item.
(Inherited from BindingListReferenceLinkSettings.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToXml
This is used to save the reference link 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 BindingListReferenceLinkSettings.)
Public propertyAllowNew
Gets or sets a value indicating whether you can add items to the list using the AddNew method.
(Inherited from BindingListReferenceLinkSettings.)
Public propertyAllowRemove
Gets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingListReferenceLinkSettings.)
Public propertyCount (Inherited from CollectionReferenceLinkSettings.)
Protected propertyIsSortedCore
Gets a value indicating whether the list is sorted.
(Inherited from BindingListReferenceLinkSettings.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionReferenceLinkSettings.)
Protected propertyItems (Inherited from CollectionReferenceLinkSettings.)
Public propertyRaiseListChangedEvents
Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingListReferenceLinkSettings.)
Protected propertySortDirectionCore
Gets the direction the list is sorted.
(Inherited from BindingListReferenceLinkSettings.)
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 BindingListReferenceLinkSettings.)
Protected propertySupportsChangeNotificationCore
Gets a value indicating whether ListChanged events are enabled.
(Inherited from BindingListReferenceLinkSettings.)
Protected propertySupportsSearchingCore
Gets a value indicating whether the list supports searching.
(Inherited from BindingListReferenceLinkSettings.)
Protected propertySupportsSortingCore
Gets a value indicating whether the list supports sorting.
(Inherited from BindingListReferenceLinkSettings.)
Top
Events
  NameDescription
Public eventAddingNew
Occurs before an item is added to the list.
(Inherited from BindingListReferenceLinkSettings.)
Public eventListChanged
Occurs when the list or an item in the list changes.
(Inherited from BindingListReferenceLinkSettings.)
Top
See Also