ImageReferenceCollection Class

This collection class is used to hold the conceptual content image references for a project.

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionImageReference
    System.ComponentModelBindingListImageReference
      SandcastleBuilder.Utils.ConceptualContentImageReferenceCollection

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

Syntax

C++

Copy

public class ImageReferenceCollection : BindingList<ImageReference>

Public Class ImageReferenceCollection
	Inherits BindingList(Of ImageReference)

public ref class ImageReferenceCollection : public BindingList<ImageReference^>

type ImageReferenceCollection =  
    class
        inherit BindingList<ImageReference>
    end

The ImageReferenceCollection type exposes the following members.

Constructors

	Name	Description
	ImageReferenceCollection	Constructor

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionImageReference.)
	AddNew	Adds a new item to the collection. (Inherited from BindingListImageReference.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListImageReference.)
	ApplySortCore	Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListImageReference.)
	CancelNew	Discards a pending new item. (Inherited from BindingListImageReference.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionImageReference.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListImageReference.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionImageReference.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionImageReference.)
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListImageReference.)
	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 BindingListImageReference.)
	FindId	Find the image with the specified ID (case-insensitive).
	FindImageFile	Find the image with the specified filename.
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionImageReference.)
	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 CollectionImageReference.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionImageReference.)
	InsertItem	Inserts the specified item in the list at the specified index. (Inherited from BindingListImageReference.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListImageReference.)
	OnListChanged	Raises the ListChanged event. (Inherited from BindingListImageReference.)
	Refresh	This is used to refresh the collection by loading the image build items from the project.
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionImageReference.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionImageReference.)
	RemoveItem	Removes the item at the specified index. (Inherited from BindingListImageReference.)
	RemoveSortCore	Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListImageReference.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListImageReference.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListImageReference.)
	SaveAsSharedContent	Write the image reference collection to a map file ready for use by BuildAssembler.
	SetItem	Replaces the item at the specified index with the specified item. (Inherited from BindingListImageReference.)
	Sort	This is used to sort the collection
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AllowEdit	Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListImageReference.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListImageReference.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListImageReference.)
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionImageReference.)
	IsSortedCore	Gets a value indicating whether the list is sorted. (Inherited from BindingListImageReference.)
	ItemInt32	Gets or sets the element at the specified index. (Inherited from CollectionImageReference.)
	ItemString	This can be used to get an image by its unique ID (case-sensitive)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionImageReference.)
	RaiseListChangedEvents	Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListImageReference.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListImageReference.)
	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 BindingListImageReference.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListImageReference.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListImageReference.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListImageReference.)

Top

Events

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

Top

Reference

SandcastleBuilder.Utils.ConceptualContent Namespace