HttpCookiesSection Class

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Configures properties for cookies used by a Web application.

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class HttpCookiesSection sealed : System::Configuration::ConfigurationSection

public sealed class HttpCookiesSection : System.Configuration.ConfigurationSection

type HttpCookiesSection = class
    inherit ConfigurationSection

Public NotInheritable Class HttpCookiesSection
Inherits ConfigurationSection

Inheritance: Object

ConfigurationElement

ConfigurationSection
HttpCookiesSection

Examples

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


  // Get the Web application configuration.
  System.Configuration.Configuration webConfig =
  WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

  // Get the section.
  string configPath = "system.web/httpCookies";
  System.Web.Configuration.HttpCookiesSection httpCookiesSection =
  (System.Web.Configuration.HttpCookiesSection)webConfig.GetSection(
  configPath);


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

 ' Get the section.
 Dim configPath As String _
 = "system.web/httpCookies"

 Dim httpCookiesSection _
 As System.Web.Configuration.HttpCookiesSection = _
 CType(webConfig.GetSection(configPath), _
 System.Web.Configuration.HttpCookiesSection)

Remarks

The HttpCookiesSection class provides a way to programmatically access and modify the httpCookies section of a configuration file.

It defines the settings applied by default to all cookies issued by the application, unless the code issuing the cookie overrides them.

One objective of the httpCookies element is to support the use of HttpOnly cookies. HttpOnly cookies (cookies with the HttpOnly attribute) were introduced in Internet Explorer 6 to help mitigate the risk of cross-site scripting. The HttpOnly attribute prevents cookies from being accessed through client-side script. Any information contained in an HttpOnly cookie is less likely to be disclosed to a hacker or a malicious Web site. For more information, search MSDN (msdn.microsoft.com) for "HttpOnly."

Note

The HttpCookiesSection can read and write information from and to the related section of the configuration file according to the section property AllowDefinition whose value is Everywhere.

Constructors

HttpCookiesSection()

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the HttpCookiesSection class.

Properties

CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement)
Domain	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the cookie domain name.
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
HttpOnlyCookies	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether the support for the browser's `HttpOnly` cookie is enabled.
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[String]	Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement)
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RequireSSL	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether Secure Sockets Layer (SSL) communication is required.
SameSite	Gets or sets the value for the SameSite attribute of the cookie.
SectionInformation	Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection)

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
DeserializeSection(XmlReader)	Reads XML from the configuration file. (Inherited from ConfigurationSection)
Equals(Object)	Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement)
GetHashCode()	Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement)
GetRuntimeObject()	Returns a custom object when overridden in a derived class. (Inherited from ConfigurationSection)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. (Inherited from ConfigurationSection)
IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Reset(ConfigurationElement)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement)
ResetModified()	Resets the value of the IsModified() method to `false` when implemented in a derived class. (Inherited from ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file. (Inherited from ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

Applies to

Поділитися через