This topic has not yet been rated - Rate this topic

StyleCollection Class

Represents a collection of Style objects.

System.Object
  System.Web.UI.StateManagedCollection
    System.Web.UI.WebControls.StyleCollection

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
public class StyleCollection : StateManagedCollection

The StyleCollection type exposes the following members.

  Name Description
Public property Count Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public property Item Gets the Style object at the specified index location in the StyleCollection object.
Top
  Name Description
Public method Add Appends a specified Style object to the end of the StyleCollection object.
Public method Clear Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method Contains Determines whether the specified style is contained within the collection.
Public method CopyTo(Array, Int32) Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection.)
Public method CopyTo(Style[], Int32) Copies the elements of the StyleCollection to a one-dimensional Style array, starting at the specified index of the target array.
Protected method CreateKnownType Creates an instance of the Style class, based on the single element collection returned by the GetKnownTypes method. (Overrides StateManagedCollection.CreateKnownType(Int32).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetKnownTypes Gets an array of the IStateManager types that the StyleCollection can contain. (Overrides StateManagedCollection.GetKnownTypes().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Returns the index of the specified Style object within the collection.
Public method Insert Inserts a specified Style object into the StyleCollection at the specified index location.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClear When overridden in a derived class, performs additional work before the Clear method removes all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnClearComplete When overridden in a derived class, performs additional work after the Clear method finishes removing all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnInsert When overridden in a derived class, performs additional work before the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnInsertComplete When overridden in a derived class, performs additional work after the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnRemove When overridden in a derived class, performs additional work before the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnRemoveComplete When overridden in a derived class, performs additional work after the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnValidate When overridden in a derived class, validates an element of the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method Remove Removes the specified Style object from the StyleCollection object.
Public method RemoveAt Removes the Style object at the specified index location from the StyleCollection object.
Public method SetDirty Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.)
Protected method SetDirtyObject Instructs the input Style object contained in the collection to record its entire state to view state, rather than recording only change information. (Overrides StateManagedCollection.SetDirtyObject(Object).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private property ICollection.Count Infrastructure. Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the StateManagedCollection collection. This method returns null in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IEnumerable.GetEnumerator Infrastructure. Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Add Adds an item to the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Clear Infrastructure. Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Contains Determines whether the StateManagedCollection collection contains a specific value. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.IndexOf Determines the index of a specified item in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Insert Inserts an item into the StateManagedCollection collection at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsReadOnly Infrastructure. Gets a value indicating whether the StateManagedCollection collection is read-only. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.Item Infrastructure. Gets the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of the specified object from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.RemoveAt Removes the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.LoadViewState Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.SaveViewState Saves the changes to the StateManagedCollection collection and each IStateManager object it contains since the time the page was posted back to the server. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.TrackViewState Causes the StateManagedCollection collection and each of the IStateManager objects it contains to track changes to their view state so they can be persisted across requests for the same page. (Inherited from StateManagedCollection.)
Top

Use the StyleCollection class to store and manage Style objects for a control. Control developers can use this class to contain a set of styles that apply to different portions of the control.

The collection dynamically increases in size as objects are added. Indexes in this collection are zero-based. Use the Count property to determine how many objects are in the collection.

Additionally, use the StyleCollection methods and properties to provide the following functionality:

  • The Add method to add a single style to the collection.

  • The Insert method to add a style at a particular index within the collection.

  • The Remove method to remove a style from the collection.

  • The RemoveAt method to remove the style located at a particular index.

  • The Contains method to determine whether a particular style is already in the collection.

  • The IndexOf method to retrieve the index of a style within the collection.

  • The Clear method to remove all the styles from the collection.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ