MSHelpKeywordCollection Class

HTML to MAML Converter

previous page next page
MSHelpKeywordCollection Class
This collection class is used to hold the help index keyword items for a project.
Inheritance Hierarchy

Namespace: SandcastleBuilder.Utils
Assembly: ConvertHtmlToMaml (in ConvertHtmlToMaml.exe) Version: 1.0.0.2
Syntax
Copy
public class MSHelpKeywordCollection : BindingList<MSHelpKeyword>
Public Class MSHelpKeywordCollection
	Inherits BindingList(Of MSHelpKeyword)
public ref class MSHelpKeywordCollection : public BindingList<MSHelpKeyword^>
type MSHelpKeywordCollection =  
    class
        inherit BindingList<MSHelpKeyword>
    end

The MSHelpKeywordCollection type exposes the following members.

Constructors
  NameDescription
Public methodMSHelpKeywordCollection
Initializes a new instance of the MSHelpKeywordCollection class
Top
Properties
  NameDescription
Public propertyAllowEdit
Gets or sets a value indicating whether items in the list can be edited.
(Inherited from BindingListMSHelpKeyword.)
Public propertyAllowNew
Gets or sets a value indicating whether you can add items to the list using the AddNew method.
(Inherited from BindingListMSHelpKeyword.)
Public propertyAllowRemove
Gets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingListMSHelpKeyword.)
Public propertyCount
Gets the number of elements actually contained in the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Protected propertyIsSortedCore
Gets a value indicating whether the list is sorted.
(Inherited from BindingListMSHelpKeyword.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionMSHelpKeyword.)
Protected propertyItems
Gets a IListT wrapper around the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Public propertyRaiseListChangedEvents
Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingListMSHelpKeyword.)
Protected propertySortDirectionCore
Gets the direction the list is sorted.
(Inherited from BindingListMSHelpKeyword.)
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 BindingListMSHelpKeyword.)
Protected propertySupportsChangeNotificationCore
Gets a value indicating whether ListChanged events are enabled.
(Inherited from BindingListMSHelpKeyword.)
Protected propertySupportsSearchingCore
Gets a value indicating whether the list supports searching.
(Inherited from BindingListMSHelpKeyword.)
Protected propertySupportsSortingCore
Gets a value indicating whether the list supports sorting.
(Inherited from BindingListMSHelpKeyword.)
Top
Methods
  NameDescription
Public methodAdd
Adds an object to the end of the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Public methodAddNew
Adds a new item to the collection.
(Inherited from BindingListMSHelpKeyword.)
Protected methodAddNewCore
Adds a new item to the end of the collection.
(Inherited from BindingListMSHelpKeyword.)
Protected methodApplySortCore
Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingListMSHelpKeyword.)
Public methodCancelNew
Discards a pending new item.
(Inherited from BindingListMSHelpKeyword.)
Public methodClear
Removes all elements from the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Protected methodClearItems
Removes all elements from the collection.
(Inherited from BindingListMSHelpKeyword.)
Public methodContains
Determines whether an element is in the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Public methodCopyTo
Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from CollectionMSHelpKeyword.)
Public methodEndNew
Commits a pending new item to the collection.
(Inherited from BindingListMSHelpKeyword.)
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 BindingListMSHelpKeyword.)
Public methodGetEnumerator
Returns an enumerator that iterates through the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Public methodGetHashCode
Serves as the default hash function.
(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 CollectionMSHelpKeyword.)
Public methodInsert
Inserts an element into the CollectionT at the specified index.
(Inherited from CollectionMSHelpKeyword.)
Protected methodInsertItem
Inserts the specified item in the list at the specified index.
(Inherited from BindingListMSHelpKeyword.)
Public methodMarkAsDirty
This is used to mark the collection as changed when there is no associated project.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from BindingListMSHelpKeyword.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from BindingListMSHelpKeyword.)
Public methodRemove
Removes the first occurrence of a specific object from the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Public methodRemoveAt
Removes the element at the specified index of the CollectionT.
(Inherited from CollectionMSHelpKeyword.)
Protected methodRemoveItem
Removes the item at the specified index.
(Inherited from BindingListMSHelpKeyword.)
Protected methodRemoveSortCore
Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingListMSHelpKeyword.)
Public methodResetBindings
Raises a ListChanged event of type Reset.
(Inherited from BindingListMSHelpKeyword.)
Public methodResetItem
Raises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingListMSHelpKeyword.)
Protected methodSetItem
Replaces the item at the specified index with the specified item.
(Inherited from BindingListMSHelpKeyword.)
Public methodSort
This is used to sort the collection
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteXml
This is used to save the keyword collection to the project file.
Top
Events
  NameDescription
Public eventAddingNew
Occurs before an item is added to the list.
(Inherited from BindingListMSHelpKeyword.)
Public eventListChanged
Occurs when the list or an item in the list changes.
(Inherited from BindingListMSHelpKeyword.)
Top
See Also
previous page start next page