SectionInformation.AllowLocation Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-rc.2.24473.5

Source:

SectionInformation.cs

Gets or sets a value that indicates whether the configuration section allows the location attribute.

public:
 property bool AllowLocation { bool get(); void set(bool value); };

public bool AllowLocation { get; set; }

member this.AllowLocation : bool with get, set

Public Property AllowLocation As Boolean

Property Value

Boolean

true if the location attribute is allowed; otherwise, false. The default is true.

Exceptions

ConfigurationErrorsException

The selected value conflicts with a value that is already defined.

Examples

The examples in this section show how to get the AllowLocation property value after accessing the related section information in the configuration file.

The following example gets the SectionInformation object.

// Get the current configuration file.
System.Configuration.Configuration config =
        ConfigurationManager.OpenExeConfiguration(
        ConfigurationUserLevel.None);

// Get the section.
UrlsSection section =
    (UrlsSection)config.GetSection("MyUrls");

SectionInformation sInfo =
    section.SectionInformation;

' Get the current configuration file.
Dim config _
As System.Configuration.Configuration = _
ConfigurationManager.OpenExeConfiguration( _
ConfigurationUserLevel.None)

' Get the section.
Dim section As UrlsSection = _
CType(config.GetSection("MyUrls"), UrlsSection)

Dim sInfo As SectionInformation = _
section.SectionInformation

The following example gets the AllowLocation value.

bool allowLocation =
    sInfo.AllowLocation;
Console.WriteLine("Allow location: {0}",
               allowLocation.ToString());

Dim allowLocation As Boolean = _
sInfo.AllowLocation
Console.WriteLine("Allow location: {0}", _
allowLocation.ToString())

Remarks

When set to false, the AllowLocation property indicates that the section is accessed by native-code readers. Therefore, the use of the location attribute is not allowed, because the native-code readers do not support the concept of location.