CookieHandlerElement Class

.NET Framework (current version)
 

Represents the <cookieHandler> configuration element.

Namespace:   System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

System.Object
  System.Configuration.ConfigurationElement
    System.IdentityModel.Services.CookieHandlerElement

public class CookieHandlerElement : ConfigurationElement

NameDescription
System_CAPS_pubmethodCookieHandlerElement()

Initializes a new instance of the CookieHandlerElement class.

NameDescription
System_CAPS_pubpropertyChunkedCookieHandler

Gets or sets a chunked cookie handler.

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_pubpropertyCustomCookieHandler

Gets or sets a custom cookie handler type. This property must be set when a custom cookie handler is being configured.

System_CAPS_pubpropertyDomain

Gets or sets the domain value for cookies written by the handler.

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_protpropertyEvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyHasContext

(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyHideFromScript

Gets or sets a value that specifies whether the httpOnly property of the cookies written by this handler should be set.

System_CAPS_protpropertyItem[ConfigurationProperty]

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

System_CAPS_protpropertyItem[String]

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

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_pubpropertyMode

Gets or sets the cookie handler mode.

System_CAPS_pubpropertyName

Gets or sets the base name for any cookies written by the handler.

System_CAPS_pubpropertyPath

Gets or sets the path value for cookies written by the handler.

System_CAPS_pubpropertyPersistentSessionLifetime

Gets or sets the lifetime of cookies issued by the handler.

System_CAPS_protpropertyProperties

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

System_CAPS_pubpropertyRequireSsl

Gets or sets a value that specifies whether the cookie should be used only with SSL.

NameDescription
System_CAPS_protmethodDeserializeElement(XmlReader, Boolean)

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

System_CAPS_pubmethodEquals(Object)

Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetConfiguredCookieHandler()

Gets a new cookie handler based on the configuration properties.

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_protmethodGetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)

System_CAPS_protmethodGetTransformedTypeString(String)

Returns the transformed version of the specified type name.(Inherited from ConfigurationElement.)

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 configuration element has been modified since it was last saved or loaded, when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodIsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)

System_CAPS_protmethodListErrors(IList)

Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.(Inherited from ConfigurationElement.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.(Inherited from ConfigurationElement.)

System_CAPS_protmethodOnDeserializeUnrecognizedElement(String, XmlReader)

Gets a value indicating whether an unknown element is encountered during deserialization.(Inherited from ConfigurationElement.)

System_CAPS_protmethodOnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.(Inherited from ConfigurationElement.)

System_CAPS_protmethodPostDeserialize()

Called after deserialization.(Inherited from ConfigurationElement.)

System_CAPS_protmethodPreSerialize(XmlWriter)

Called before serialization.(Inherited from ConfigurationElement.)

System_CAPS_protmethodReset(ConfigurationElement)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)

System_CAPS_protmethodResetModified()

Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSerializeElement(XmlWriter, Boolean)

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

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_protmethodSetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSetReadOnly()

Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodToString()

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

System_CAPS_protmethodUnmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

The <cookieHandler> element is a child element of the <federatedAuthentication> element; the P:System.IdentityModel.Services.FederatedAuthenticationElement.CookieHandler property is set to an instance of the CookieHandlerElement class. The <cookieHandler> element is used to configure the cookie handler used by the Session Authentication Module (SAM), which is represented by the SessionAuthenticationModule class.

A cookie handler can be configured in one of the following ways:

.NET Framework
Available since 4.5

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: