Click or drag to resize
Sandcastle Help File BuilderCodeSnippetCollection Class
This collection class is used to hold the conceptual content code snippet information for an associated code snippets file.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionCodeReference
    System.ComponentModelBindingListCodeReference
      SandcastleBuilder.Utils.ConceptualContentCodeSnippetCollection

Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax
public class CodeSnippetCollection : BindingList<CodeReference>

The CodeSnippetCollection type exposes the following members.

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