HostingEnvironmentSection Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Definuje nastavení konfigurace, které řídí chování hostitelského prostředí aplikace. Tato třída se nemůže dědit.
public ref class HostingEnvironmentSection sealed : System::Configuration::ConfigurationSection
public sealed class HostingEnvironmentSection : System.Configuration.ConfigurationSection
type HostingEnvironmentSection = class
inherit ConfigurationSection
Public NotInheritable Class HostingEnvironmentSection
Inherits ConfigurationSection
- Dědičnost
Příklady
Tento příklad ukazuje, jak zadat hodnoty deklarativní pro několik atributů hostingEnvironment – element (ASP.NET Settings Schema) oddíl, ke kterému lze přistupovat také jako členové třídy HostingEnvironmentSection.
Následující příklad konfiguračního souboru ukazuje, jak deklarativní zadat hodnoty pro hostingEnvironment – element (ASP.NET Settings Schema) oddílu.
<system.web>
<hostingEnvironment
idleTimeout="20"
shutdownTimeout="30"
/>
</system.web>
Následující příklad kódu ukazuje, jak používat HostingEnvironmentSection třídu.
#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 UsingHostingEnvironmentSection
{
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.
HostingEnvironmentSection configSection =
(HostingEnvironmentSection)config.GetSection("system.web/hostingEnvironment");
// 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 IdleTimout property
Console.WriteLine("Idle Timeout: {0}", configSection.IdleTimeout);
// Set IdleTimout property
configSection.IdleTimeout = TimeSpan.FromMinutes(40);
// Display ShutdownTimeout property
Console.WriteLine("Shutdown Timeout: {0}", configSection.ShutdownTimeout);
// Set ShutdownTimeout property
configSection.ShutdownTimeout = TimeSpan.FromSeconds(60);
// 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.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration
Namespace Samples.Aspnet.SystemWebConfiguration
Class UsingSiteMapSection
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 = _
System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)
' Get the section related object.
Dim configSection As System.Web.Configuration.HostingEnvironmentSection = _
CType(config.GetSection("system.web/hostingEnvironment"), System.Web.Configuration.HostingEnvironmentSection)
' 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 the IdleTimout property
Console.WriteLine("Idle Timeout: {0}", configSection.IdleTimeout)
' Set the IdleTimout property
configSection.IdleTimeout = TimeSpan.FromMinutes(40)
' Display the ShutdownTimeout property
Console.WriteLine("Shutdown Timeout: {0}", configSection.ShutdownTimeout)
' Set the ShutdownTimeout property
configSection.ShutdownTimeout = TimeSpan.FromSeconds(60)
' 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
Poznámky
Třída HostingEnvironmentSection poskytuje způsob, jak programově přistupovat a upravovat hodnoty oddílu HostingEnvironmentSection v konfiguračním souboru. Pokud se aplikace ASP.NET po určitou dobu nepoužívá, může být uvolněna z paměti na základě vlastností IdleTimeout a ShutdownTimeout.
Konstruktory
| Name | Description |
|---|---|
| HostingEnvironmentSection() |
Inicializuje novou instanci HostingEnvironmentSection třídy pomocí výchozího nastavení. |
Vlastnosti
| Name | Description |
|---|---|
| CurrentConfiguration |
Získá odkaz na instanci nejvyšší úrovně Configuration, která představuje hierarchii konfigurace, do které patří aktuální instance ConfigurationElement. (Zděděno od ConfigurationElement) |
| ElementInformation |
Získá ElementInformation objekt, který obsahuje neuzpůsobitelné informace a funkce ConfigurationElement objektu. (Zděděno od ConfigurationElement) |
| ElementProperty |
Získá ConfigurationElementProperty objekt, který představuje ConfigurationElement objekt sám. (Zděděno od ConfigurationElement) |
| EvaluationContext |
Získá objekt ContextInformation pro objekt ConfigurationElement. (Zděděno od ConfigurationElement) |
| HasContext |
Získá hodnotu, která určuje, zda CurrentConfiguration vlastnost je |
| IdleTimeout |
Získá nebo nastaví dobu v minutách před uvolněním neaktivní aplikace. |
| Item[ConfigurationProperty] |
Získá nebo nastaví vlastnost nebo atribut tohoto elementu konfigurace. (Zděděno od ConfigurationElement) |
| Item[String] |
Získá nebo nastaví vlastnost, atribut nebo podřízený prvek tohoto konfiguračního elementu. (Zděděno od ConfigurationElement) |
| LockAllAttributesExcept |
Získá kolekci uzamčených atributů. (Zděděno od ConfigurationElement) |
| LockAllElementsExcept |
Získá kolekci uzamčených prvků. (Zděděno od ConfigurationElement) |
| LockAttributes |
Získá kolekci uzamčených atributů. (Zděděno od ConfigurationElement) |
| LockElements |
Získá kolekci uzamčených prvků. (Zděděno od ConfigurationElement) |
| LockItem |
Získá nebo nastaví hodnotu označující, zda je prvek uzamčen. (Zděděno od ConfigurationElement) |
| Properties |
Získá kolekci vlastností. (Zděděno od ConfigurationElement) |
| SectionInformation |
SectionInformation Získá objekt, který obsahuje neuzpůsobitelné informace a funkce objektuConfigurationSection. (Zděděno od ConfigurationSection) |
| ShadowCopyBinAssemblies |
Získá nebo nastaví hodnotu určující, zda sestavení aplikace v bin jsou stín zkopírovány do ASP.NET adresář dočasné soubory aplikace. |
| ShutdownTimeout |
Získá nebo nastaví dobu v sekundách pro řádné vypnutí aplikace. |
| UrlMetadataSlidingExpiration |
Získá nebo nastaví hodnotu, která určuje, jak ASP.NET ukládá metadata adresy URL do mezipaměti. |
Metody
| Name | Description |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Načte XML z konfiguračního souboru. (Zděděno od ConfigurationElement) |
| DeserializeSection(XmlReader) |
Načte XML z konfiguračního souboru. (Zděděno od ConfigurationSection) |
| Equals(Object) |
Porovná aktuální ConfigurationElement instanci se zadaným objektem. (Zděděno od ConfigurationElement) |
| GetHashCode() |
Získá jedinečnou hodnotu představující aktuální ConfigurationElement instanci. (Zděděno od ConfigurationElement) |
| GetRuntimeObject() |
Vrátí vlastní objekt při přepsání v odvozené třídě. (Zděděno od ConfigurationSection) |
| GetTransformedAssemblyString(String) |
Vrátí transformovanou verzi zadaného názvu sestavení. (Zděděno od ConfigurationElement) |
| GetTransformedTypeString(String) |
Vrátí transformovanou verzi zadaného názvu typu. (Zděděno od ConfigurationElement) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| Init() |
Nastaví objekt ConfigurationElement na jeho počáteční stav. (Zděděno od ConfigurationElement) |
| InitializeDefault() |
Slouží k inicializaci výchozí sady hodnot pro objekt ConfigurationElement. (Zděděno od ConfigurationElement) |
| IsModified() |
Určuje, zda byl tento konfigurační prvek změněn od posledního uložení nebo načtení při implementaci v odvozené třídě. (Zděděno od ConfigurationSection) |
| IsReadOnly() |
Získá hodnotu určující, zda ConfigurationElement objekt je jen pro čtení. (Zděděno od ConfigurationElement) |
| ListErrors(IList) |
Přidá chyby neplatné vlastnosti v tomto ConfigurationElement objektu a ve všech dílčích poplatcích do předaného seznamu. (Zděděno od ConfigurationElement) |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Získá hodnotu určující, zda neznámý atribut je zjištěn během deserializace. (Zděděno od ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Získá hodnotu určující, zda neznámý prvek je zjištěn během deserializace. (Zděděno od ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Vyvolá výjimku, pokud nebyla nalezena požadovaná vlastnost. (Zděděno od ConfigurationElement) |
| PostDeserialize() |
Volal po deserializaci. (Zděděno od ConfigurationElement) |
| PreSerialize(XmlWriter) |
Volá se před serializací. (Zděděno od ConfigurationElement) |
| Reset(ConfigurationElement) |
Obnoví vnitřní stav objektu ConfigurationElement , včetně zámků a kolekcí vlastností. (Zděděno od ConfigurationElement) |
| ResetModified() |
Obnoví hodnotu IsModified() metody na |
| SerializeElement(XmlWriter, Boolean) |
Zapíše obsah tohoto konfiguračního prvku do konfiguračního souboru při implementaci v odvozené třídě. (Zděděno od ConfigurationElement) |
| SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) |
Vytvoří řetězec XML obsahující nerozčleněné zobrazení objektu ConfigurationSection jako jeden oddíl pro zápis do souboru. (Zděděno od ConfigurationSection) |
| SerializeToXmlElement(XmlWriter, String) |
Zapíše vnější značky tohoto konfiguračního prvku do konfiguračního souboru při implementaci v odvozené třídě. (Zděděno od ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Nastaví vlastnost na zadanou hodnotu. (Zděděno od ConfigurationElement) |
| SetReadOnly() |
IsReadOnly() Nastaví vlastnost pro ConfigurationElement objekt a všechny dílčí prvky. (Zděděno od ConfigurationElement) |
| ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Určuje, zda zadaný prvek má být serializován, když je hierarchie objektu konfigurace serializována pro zadanou cílovou verzi .NET Framework. (Zděděno od ConfigurationSection) |
| ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) |
Určuje, zda má být zadaná vlastnost serializována, pokud je hierarchie objektu konfigurace serializována pro zadanou cílovou verzi .NET Framework. (Zděděno od ConfigurationSection) |
| ShouldSerializeSectionInTargetVersion(FrameworkName) |
Určuje, zda aktuální ConfigurationSection instance by měla být serializována, pokud je hierarchie objektů konfigurace serializována pro zadanou cílovou verzi .NET Framework. (Zděděno od ConfigurationSection) |
| ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Upraví objekt tak ConfigurationElement , aby odebral všechny hodnoty, které by neměly být uloženy. (Zděděno od ConfigurationElement) |