MSHelpAttrCollection Class

This collection class is used to hold the help attribute items for a project

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionMSHelpAttr
    System.ComponentModelBindingListMSHelpAttr
      SandcastleBuilder.UtilsMSHelpAttrCollection

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class MSHelpAttrCollection : BindingList<MSHelpAttr>

Public Class MSHelpAttrCollection
	Inherits BindingList(Of MSHelpAttr)

public ref class MSHelpAttrCollection : public BindingList<MSHelpAttr^>

type MSHelpAttrCollection =  
    class
        inherit BindingList<MSHelpAttr>
    end

The MSHelpAttrCollection type exposes the following members.

Constructors

	Name	Description
	MSHelpAttrCollection	Constructor

Top

Methods

	Name	Description
	Add(T)	Adds an object to the end of the CollectionT. (Inherited from CollectionMSHelpAttr.)
	Add(String, String)	Add a new item to the collection
	AddNew	Adds a new item to the collection. (Inherited from BindingListMSHelpAttr.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListMSHelpAttr.)
	ApplySortCore	Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListMSHelpAttr.)
	CancelNew	Discards a pending new item. (Inherited from BindingListMSHelpAttr.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionMSHelpAttr.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListMSHelpAttr.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionMSHelpAttr.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionMSHelpAttr.)
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListMSHelpAttr.)
	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.)
	FindCore	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 BindingListMSHelpAttr.)
	FromXml	This is used to load existing help attribute items from the project file
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionMSHelpAttr.)
	GetHashCode	Serves as a hash function for a particular type. (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 CollectionMSHelpAttr.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionMSHelpAttr.)
	InsertItem	Inserts the specified item in the list at the specified index. (Inherited from BindingListMSHelpAttr.)
	MarkAsDirty	This is used to mark the collection as changed when there is no associated project
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListMSHelpAttr.)
	OnListChanged	This is overridden to mark the collection as dirty when it changes (Overrides BindingListTOnListChanged(ListChangedEventArgs).)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionMSHelpAttr.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionMSHelpAttr.)
	RemoveItem	Removes the item at the specified index. (Inherited from BindingListMSHelpAttr.)
	RemoveSortCore	Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListMSHelpAttr.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListMSHelpAttr.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListMSHelpAttr.)
	SetItem	Replaces the item at the specified index with the specified item. (Inherited from BindingListMSHelpAttr.)
	Sort	This is used to sort the collection
	ToConfigurationString	Convert the collection to its string form for use in the sandcastle.config file
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToXml	This is used to write the help attribute info to an XML fragment ready for storing in the project file.

Top

Properties

	Name	Description
	AllowEdit	Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListMSHelpAttr.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListMSHelpAttr.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListMSHelpAttr.)
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionMSHelpAttr.)
	IsDirty	This is used to get or set the dirty state of the collection
	IsSortedCore	Gets a value indicating whether the list is sorted. (Inherited from BindingListMSHelpAttr.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionMSHelpAttr.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionMSHelpAttr.)
	RaiseListChangedEvents	Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListMSHelpAttr.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListMSHelpAttr.)
	SortPropertyCore	Gets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns null. (Inherited from BindingListMSHelpAttr.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListMSHelpAttr.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListMSHelpAttr.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListMSHelpAttr.)

Top

Events

	Name	Description
	AddingNew	Occurs before an item is added to the list. (Inherited from BindingListMSHelpAttr.)
	ListChanged	Occurs when the list or an item in the list changes. (Inherited from BindingListMSHelpAttr.)

Top

Reference

SandcastleBuilder.Utils Namespace