GlobalizationSection GlobalizationSection GlobalizationSection GlobalizationSection Class

Definition

Defines configuration settings that are used to support the globalization infrastructure of Web applications. This class cannot be inherited.

public ref class GlobalizationSection sealed : System::Configuration::ConfigurationSection
public sealed class GlobalizationSection : System.Configuration.ConfigurationSection
type GlobalizationSection = class
    inherit ConfigurationSection
Public NotInheritable Class GlobalizationSection
Inherits ConfigurationSection
Inheritance

Examples

This example demonstrates how to specify values declaratively for several attributes of the globalization section, which can also be accessed as members of the GlobalizationSection class.

The following configuration file example shows how to specify values declaratively for the globalization section.

<system.web>  
  <globalization   
    requestEncoding="utf-8"  
    responseEncoding="utf-8"/>  
</system.web>  

The following code example demonstrates how to use the GlobalizationSection class.

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingGlobalizationSection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        GlobalizationSection configSection =
          (GlobalizationSection)config.GetSection("system.web/globalization");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display Culture property.
        Console.WriteLine("Culture: {0}",
          configSection.Culture);
        
        // Set Culture property.
        configSection.Culture = 
          System.Globalization.CultureInfo.CurrentCulture.ToString();
         
        // Display EnableClientBasedCulture property.
        Console.WriteLine("EnableClientBasedCulture: {0}", 
          configSection.EnableClientBasedCulture);

        // Set EnableClientBasedCulture property.
        configSection.EnableClientBasedCulture = false;

        // Display FileEncoding property.
        Console.WriteLine("FileEncoding: {0}", 
          configSection.FileEncoding);

        // Set FileEncoding property.
        configSection.FileEncoding = 
          System.Text.Encoding.UTF8;

        // Display RequestEncoding property.
        Console.WriteLine("RequestEncoding: {0}",
          configSection.RequestEncoding);

        // Set RequestEncoding property.
        configSection.RequestEncoding = 
          System.Text.Encoding.UTF8;

        // Display ResponseEncoding property.
        Console.WriteLine("ResponseEncoding: {0}",
          configSection.ResponseEncoding);

        // Set ResponseEncoding property.
        configSection.ResponseEncoding = 
          System.Text.Encoding.UTF8;

        // Display ResponseHeaderEncoding property.
        Console.WriteLine("ResponseHeaderEncoding: {0}", 
          configSection.ResponseHeaderEncoding);

        // Set ResponseHeaderEncoding property.
        configSection.ResponseHeaderEncoding = 
          System.Text.Encoding.UTF8;

        // Display UICulture property.
        Console.WriteLine("UICulture: {0}",
          configSection.UICulture);

        // Set UICulture property.
         configSection.UICulture = 
           System.Globalization.CultureInfo.CurrentUICulture.ToString();

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingGlobalizationSection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.GlobalizationSection = _
         CType(config.GetSection("system.web/globalization"), _
         System.Web.Configuration.GlobalizationSection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display Culture property.
        Console.WriteLine("Culture: {0}", _
         configSection.Culture)

        ' Set Culture property.
        configSection.Culture = _
         System.Globalization.CultureInfo.CurrentCulture.ToString()

        ' Display EnableClientBasedCulture property.
        Console.WriteLine("EnableClientBasedCulture: {0}", _
         configSection.EnableClientBasedCulture)

        ' Set EnableClientBasedCulture property.
        configSection.EnableClientBasedCulture = False

        ' Display FileEncoding property.
        Console.WriteLine("FileEncoding: {0}", _
         configSection.FileEncoding)

        ' Set FileEncoding property.
        configSection.FileEncoding = _
         System.Text.Encoding.UTF8

        ' Display RequestEncoding property.
        Console.WriteLine("RequestEncoding: {0}", _
         configSection.RequestEncoding)

        ' Set RequestEncoding property.
        configSection.RequestEncoding = _
         System.Text.Encoding.UTF8

        ' Display ResponseEncoding property.
        Console.WriteLine("ResponseEncoding: {0}", _
         configSection.ResponseEncoding)

        ' Set ResponseEncoding property.
        configSection.ResponseEncoding = _
         System.Text.Encoding.UTF8

        ' Display ResponseHeaderEncoding property.
        Console.WriteLine("ResponseHeaderEncoding: {0}", _
         configSection.ResponseHeaderEncoding)

        ' Set ResponseHeaderEncoding property.
        configSection.ResponseHeaderEncoding = _
         System.Text.Encoding.UTF8

        ' Display UICulture property.
        Console.WriteLine("UICulture: {0}", _
         configSection.UICulture)

        ' Set UICulture property.
        configSection.UICulture = _
         System.Globalization.CultureInfo.CurrentUICulture.ToString()

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Remarks

The GlobalizationSection class provides a way to programmatically access and modify the content of the globalization section of the configuration file.

Constructors

GlobalizationSection() GlobalizationSection() GlobalizationSection() GlobalizationSection()

Initializes a new instance of the GlobalizationSection class by using default settings.

Properties

Culture Culture Culture Culture

Gets or sets a value specifying the default culture for processing incoming Web requests.

CurrentConfiguration CurrentConfiguration CurrentConfiguration 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)
ElementInformation ElementInformation ElementInformation ElementInformation

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

(Inherited from ConfigurationElement)
ElementProperty ElementProperty ElementProperty ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EnableBestFitResponseEncoding EnableBestFitResponseEncoding EnableBestFitResponseEncoding EnableBestFitResponseEncoding

Gets or sets a value indicating whether the best-fit character encoding for a response is enabled.

EnableClientBasedCulture EnableClientBasedCulture EnableClientBasedCulture EnableClientBasedCulture

Gets or sets a value indicating whether the Culture and UICulture properties should be based on the AcceptLanguage header field value that is sent by the client browser.

EvaluationContext EvaluationContext EvaluationContext EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
FileEncoding FileEncoding FileEncoding FileEncoding

Gets or sets a value specifying the default encoding for .aspx, .asmx, and .asax file parsing.

HasContext HasContext HasContext HasContext

Gets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String] Item[String] Item[String] Item[String]

Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes LockAttributes LockAttributes LockAttributes

Gets the collection of locked attributes

(Inherited from ConfigurationElement)
LockElements LockElements LockElements LockElements

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem LockItem LockItem LockItem

Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
Properties Properties Properties Properties

Gets the collection of properties.

(Inherited from ConfigurationElement)
RequestEncoding RequestEncoding RequestEncoding RequestEncoding

Gets or sets a value specifying the content encoding of HTTP requests.

ResourceProviderFactoryType ResourceProviderFactoryType ResourceProviderFactoryType ResourceProviderFactoryType

Gets or sets the factory type of the resource provider.

ResponseEncoding ResponseEncoding ResponseEncoding ResponseEncoding

Gets or sets a value specifying the content encoding of HTTP responses.

ResponseHeaderEncoding ResponseHeaderEncoding ResponseHeaderEncoding ResponseHeaderEncoding

Gets or sets a value specifying the header encoding of HTTP responses.

SectionInformation SectionInformation SectionInformation SectionInformation

Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object.

(Inherited from ConfigurationSection)
UICulture UICulture UICulture UICulture

Gets or sets a value specifying the default culture for processing locale-dependent resource searches.

Methods

DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
DeserializeSection(XmlReader) DeserializeSection(XmlReader) DeserializeSection(XmlReader) DeserializeSection(XmlReader)

Reads XML from the configuration file.

(Inherited from ConfigurationSection)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetRuntimeObject() GetRuntimeObject() GetRuntimeObject() GetRuntimeObject()

Returns a custom object when overridden in a derived class.

(Inherited from ConfigurationSection)
GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init() Init() Init() Init()

Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault() InitializeDefault() InitializeDefault() InitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
IsModified() IsModified() IsModified() 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() IsReadOnly() IsReadOnly() IsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList) ListErrors(IList) ListErrors(IList) ListErrors(IList)

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

(Inherited from ConfigurationElement)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader)

Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize() PostDeserialize() PostDeserialize() PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Inherited from ConfigurationElement)
ResetModified() ResetModified() ResetModified() ResetModified()

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

(Inherited from ConfigurationSection)
SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) 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) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) 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) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) 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) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly() SetReadOnly() SetReadOnly() SetReadOnly()

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

(Inherited from ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) 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) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) 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) ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName) 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() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Inherited from ConfigurationElement

Applies to

See Also