DesignerRegionCollection Class

.NET Framework (current version)

Other Versions

Represents a collection of DesignerRegion objects within a control designer.

Namespace: System.Web.UI.Design
Assembly: System.Design (in System.Design.dll)

Inheritance Hierarchy

System::Object
System.Web.UI.Design::DesignerRegionCollection

Syntax

C++

public ref class DesignerRegionCollection : IList, ICollection, 
	IEnumerable

Constructors

	Name	Description
	DesignerRegionCollection()	Initializes a new instance of the DesignerRegionCollection class.
	DesignerRegionCollection(ControlDesigner^)	Initializes a new instance of the DesignerRegionCollection class for the specified control designer.

Properties

	Name	Description
	Count	Gets the number of DesignerRegion objects in the collection.
	IsFixedSize	Gets a value indicating whether the DesignerRegionCollection object has a fixed size.
	IsReadOnly	Gets a value indicating whether the DesignerRegionCollection object is read-only.
	IsSynchronized	Gets a value indicating whether access to the DesignerRegionCollection object is synchronized (thread safe).
	Item[Int32]	Gets or sets a DesignerRegion object at the specified index in the collection.
	Owner	Gets the control designer that owns the designer region collection.
	SyncRoot	Gets an object that can be used to synchronize access to the DesignerRegionCollection object.

Methods

	Name	Description
	Add(DesignerRegion^)	Adds the specified DesignerRegion object to the end of the collection.
	Clear()	Removes all regions from the collection.
	Contains(DesignerRegion^)	Gets a value indicating whether the specified region is contained within the collection.
	CopyTo(Array^, Int32)	Copies the elements of the collection to an Array object, starting at a particular Array index.
	Equals(Object^)	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.)
	GetEnumerator()	Returns an enumerator that iterates through the collection.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IndexOf(DesignerRegion^)	Returns the index of the specified DesignerRegion object within the collection.
	Insert(Int32, DesignerRegion^)	Inserts a DesignerRegion object into the collection at the specified index.
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	Remove(DesignerRegion^)	Removes the specified DesignerRegion object from the collection.
	RemoveAt(Int32)	Removes the DesignerRegion object at the specified index within the collection.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	ICollection::CopyTo(Array^, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see CopyTo.
	IEnumerable::GetEnumerator()	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IEnumerable::GetEnumerator.
	IList::Add(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::Add.
	IList::Clear()	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::Clear.
	IList::Contains(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::Contains.
	IList::IndexOf(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::IndexOf.
	IList::Insert(Int32, Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::Insert.
	IList::Remove(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::Remove.
	IList::RemoveAt(Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::RemoveAt.
	ICollection::Count	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see ICollection::Count.
	ICollection::IsSynchronized	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see ICollection::IsSynchronized.
	ICollection::SyncRoot	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see ICollection::SyncRoot.
	IList::IsFixedSize	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::IsFixedSize.
	IList::IsReadOnly	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::IsReadOnly.
	IList::Item[Int32]	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IList::Item.

Extension Methods

	Name	Description
	AsParallel()	Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)
	AsQueryable()	Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)
	Cast<TResult>()	Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)
	OfType<TResult>()	Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

Remarks

The ControlDesigner class, and any derived class, uses the DesignerRegionCollection class to contain and enumerate the designer regions for the control in a design host, such as Visual Studio 2005.

For example, the ControlDesigner::GetDesignTimeHtml method can be used to define and add regions to the collection.

Use the Owner property to access the control designer object that contains the designer region collection. Use the DesignerRegionCollection methods and properties to examine and maintain the DesignerRegion objects that are in the collection.

The collection dynamically increases as objects are added. Indexes in this collection are zero-based. Use the Count property to determine how many designer regions are in the collection. Use the DesignerRegionCollection members to provide the following functionality:

The Add method to add a single designer region to the collection.
The Insert method to add a designer region at a particular index within the collection.
The Remove method to remove a designer region.
The RemoveAt method to remove the designer region at a particular index.
The Contains method to determine whether a particular designer region is already in the collection.
The IndexOf method to retrieve the index of a designer region within the collection.
The Item indexer to get or set the designer region at a particular index, using array notation.
The Clear method to remove all designer regions from the collection.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.