FormsAuthenticationUserCollection Class

 

Represents a collection of FormsAuthenticationUser objects. This class cannot be inherited.

Namespace:   System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationElementCollection
      System.Web.Configuration.FormsAuthenticationUserCollection

<ConfigurationCollectionAttribute(GetType(FormsAuthenticationUser),
	AddItemName := "user", CollectionType := ConfigurationElementCollectionType.BasicMap)>
Public NotInheritable Class FormsAuthenticationUserCollection
	Inherits ConfigurationElementCollection

NameDescription
System_CAPS_pubmethodFormsAuthenticationUserCollection()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the FormsAuthenticationUserCollection class.

NameDescription
System_CAPS_protpropertyAddElementName

Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)

System_CAPS_pubpropertyAllKeys

Gets all the collection's keys.

System_CAPS_protpropertyClearElementName

Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)

System_CAPS_pubpropertyCollectionType

Gets the type of the FormsAuthenticationUserCollection.(Overrides ConfigurationElementCollection.CollectionType.)

System_CAPS_pubpropertyCount

Gets the number of elements in the collection.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubpropertyCurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)

System_CAPS_protpropertyElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyEmitClear

Gets or sets a value that specifies whether the collection has been cleared.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the collection is synchronized.(Inherited from ConfigurationElementCollection.)

System_CAPS_protpropertyItem(ConfigurationProperty)

Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyItem(Int32)

Gets the FormsAuthenticationUser at the specified index.

System_CAPS_pubpropertyItem(String)

Gets the FormsAuthenticationUser with the specified name.

System_CAPS_pubpropertyLockAllAttributesExcept

Gets the collection of locked attributes.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllElementsExcept

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAttributes

Gets the collection of locked attributes (Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockElements

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockItem

Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyProperties

Gets the collection of properties.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyRemoveElementName

Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)

System_CAPS_pubpropertySyncRoot

Gets an object used to synchronize access to the ConfigurationElementCollection.(Inherited from ConfigurationElementCollection.)

NameDescription
System_CAPS_pubmethodAdd(FormsAuthenticationUser)

Adds a FormsAuthenticationUser object to the collection.

System_CAPS_protmethodBaseAdd(ConfigurationElement, Boolean)

Adds a configuration element to the configuration element collection.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseClear()

Removes all configuration element objects from the collection.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseGet(Int32)

Gets the configuration element at the specified index location.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseGet(Object)

Returns the configuration element with the specified key.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseGetAllKeys()

Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseGetKey(Int32)

Gets the key for the ConfigurationElement at the specified index location.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseIsRemoved(Object)

Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseRemove(Object)

Removes a ConfigurationElement from the collection.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodBaseRemoveAt(Int32)

Removes the ConfigurationElement at the specified index location.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodClear()

Removes all FormsAuthenticationUser objects from the collection.

System_CAPS_pubmethodCopyTo(ConfigurationElement(), Int32)

Copies the contents of the ConfigurationElementCollection to an array.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodDeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodEquals(Object)

Compares the ConfigurationElementCollection to the specified object.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodGet(Int32)

Gets the FormsAuthenticationUser collection element at the specified index.

System_CAPS_pubmethodGet(String)

Gets the FormsAuthenticationUser collection element with the specified name.

System_CAPS_pubmethodGetEnumerator()

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodGetHashCode()

Gets a unique value representing the ConfigurationElementCollection instance.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodGetKey(Int32)

Gets the key at the specified FormsAuthenticationUserCollection collection index.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInit()

Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.)

System_CAPS_protmethodInitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.)

System_CAPS_protmethodIsModified()

Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodIsReadOnly()

Indicates whether the ConfigurationElementCollection object is read only.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodRemove(String)

Removes a FormsAuthenticationUser object from the collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes a FormsAuthenticationUser object at the specified index from the collection.

System_CAPS_protmethodReset(ConfigurationElement)

Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodResetModified()

Resets the value of the IsModified property to false when overridden in a derived class.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodSerializeElement(XmlWriter, Boolean)

Writes the configuration data to an XML element in the configuration file when overridden in a derived class.(Inherited from ConfigurationElementCollection.)

System_CAPS_protmethodSerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodSet(FormsAuthenticationUser)

Modifies the specified FormsAuthenticationUser object contained in the collection.

System_CAPS_protmethodSetReadOnly()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements.(Inherited from ConfigurationElementCollection.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodUnmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

This API supports the product infrastructure and is not intended to be used directly from your code. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast(Of TResult)()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType(Of TResult)()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

The FormsAuthenticationCredentials uses the FormsAuthenticationUserCollection to programmatically access and modify the users element of the credentials section in the forms section of the authorization configuration section.

This type is part of a group that includes the FormsAuthenticationConfiguration, the FormsAuthenticationCredentials, and the FormsAuthenticationUser types.

The following code example shows how to obtain the FormsAuthenticationUserCollection object from the configuration file of an existing Web application.

System_CAPS_noteNote

If you use the credentials element be sure to follow the guidelines explained at ASP.NET Authentication. For scalability and better security, it is recommended you use an external database to store the users' credentials. For more information about building secure ASP.NET applications, search the Microsoft MSDN Web site (msdn.microsoft.com) for "Securing Your ASP.NET Application" and "Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication."

' Get the Web application configuration.
  Dim configuration As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

' Get the authentication section.
  Dim authenticationSection _
  As AuthenticationSection = _
  CType(configuration.GetSection( _
  "system.web/authentication"), AuthenticationSection)

' Get the forms credentials collection .
  Dim formsAuthenticationCredentials _
  As FormsAuthenticationCredentials = _
  authenticationSection.Forms.Credentials

.NET Framework
Available since 2.0

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

Return to top
Show: