TraceSection 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 the ASP.NET trace service. This class cannot be inherited.

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

public sealed class TraceSection : System.Configuration.ConfigurationSection

type TraceSection = class
    inherit ConfigurationSection

Public NotInheritable Class TraceSection
Inherits ConfigurationSection

Inheritance: Object

ConfigurationElement

ConfigurationSection
TraceSection

Examples

The following code example shows how to use the TraceSection type.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Text;
using System.Text.RegularExpressions;
using System.Configuration;
using System.Web.Configuration;

namespace Samples.Aspnet.SystemWebConfiguration
{
    // Accesses the System.Web.Configuration.TraceSection members
    // selected by the user.
    class UsingTraceSection
    {
        public static void Main()
        {
            // Process the System.Web.Configuration.TraceSectionobject.
            try
            {
                // Get the Web application configuration.
                System.Configuration.Configuration configuration = 
                    System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("/aspnet");
                
                // Get the section.
                System.Web.Configuration.TraceSection traceSection = 
                    (System.Web.Configuration.TraceSection) 
                    configuration.GetSection("system.web/trace");

// Get the current PageOutput property value.
Boolean pageOutputValue = traceSection.PageOutput;

// Set the PageOutput property to true.
traceSection.PageOutput = true;

                

// Get the current WriteToDiagnosticsTrace property value.
Boolean writeToDiagnosticsTraceValue = traceSection.WriteToDiagnosticsTrace;

// Set the WriteToDiagnosticsTrace property to true.
traceSection.WriteToDiagnosticsTrace = true;

                

// Get the current MostRecent property value.
Boolean mostRecentValue = traceSection.MostRecent;

// Set the MostRecent property to true.
traceSection.MostRecent = true;

                

// Get the current RequestLimit property value.
Int32 requestLimitValue = traceSection.RequestLimit;

// Set the RequestLimit property to 256.
traceSection.RequestLimit = 256;

                

// Get the current LocalOnly property value.
Boolean localOnlyValue = traceSection.LocalOnly;

// Set the LocalOnly property to false.
traceSection.LocalOnly = false;

                

// Get the current Enabled property value.
Boolean enabledValue = traceSection.Enabled;

// Set the Enabled property to false.
traceSection.Enabled = false;

                

// Get the current Mode property value.
// TraceDisplayMode modeValue = traceSection.TraceMode;

// Set the Mode property to TraceDisplayMode.SortyByTime.
// traceSection.Mode = TraceDisplayMode.SortByTime;

                
                // Update if not locked.
                if (! traceSection.SectionInformation.IsLocked)
                {
                    configuration.Save();
                    Console.WriteLine("** Configuration updated.");
                }
                else
                {
                    Console.WriteLine("** Could not update, section is locked.");
                }
            }
            catch (System.ArgumentException e)
            {
                // Unknown error.
                Console.WriteLine(
                    "A invalid argument exception detected in UsingTraceSection Main. Check your");
                Console.WriteLine("command line for errors.");
            }
        }
    } // UsingTraceSection class end.
} // Samples.Aspnet.SystemWebConfiguration namespace end.

Imports System.Collections
Imports System.Collections.Specialized
Imports System.IO
Imports System.Text
Imports System.Text.RegularExpressions
Imports System.Configuration
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
    ' Accesses the System.Web.Configuration.TraceSection members
    ' selected by the user.
    Class UsingTraceSection
        Public Shared Sub Main()
            ' Process the System.Web.Configuration.TraceSectionobject.
            Try
                ' Get the Web application configuration.
                Dim configuration As System.Configuration.Configuration = _
                    System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("/aspnet")

                ' Get the section.
                Dim traceSection As System.Web.Configuration.TraceSection = _
                    CType(configuration.GetSection("system.web/trace"), _
                    System.Web.Configuration.TraceSection)

                ' Get the current PageOutput property value.
                Dim pageOutputValue As Boolean = traceSection.PageOutput

                ' Set the PageOutput property to true.
                traceSection.PageOutput = True



                ' Get the current WriteToDiagnosticsTrace property value.
                Dim writeToDiagnosticsTraceValue As Boolean = traceSection.WriteToDiagnosticsTrace

                ' Set the WriteToDiagnosticsTrace property to true.
                traceSection.WriteToDiagnosticsTrace = True



                ' Get the current MostRecent property value.
                Dim mostRecentValue As Boolean = traceSection.MostRecent

                ' Set the MostRecent property to true.
                traceSection.MostRecent = True



                ' Get the current RequestLimit property value.
                Dim requestLimitValue As Int32 = traceSection.RequestLimit

                ' Set the RequestLimit property to 256.
                traceSection.RequestLimit = 256



                ' Get the current LocalOnly property value.
                Dim localOnlyValue As Boolean = traceSection.LocalOnly

                ' Set the LocalOnly property to false.
                traceSection.LocalOnly = False



                ' Get the current Enabled property value.
                Dim enabledValue As Boolean = traceSection.Enabled

                ' Set the Enabled property to false.
                traceSection.Enabled = False



                ' Get the current Mode property value.
                'Dim modeValue As TraceDisplayMode = traceSection.TraceMode

                ' Set the Mode property to TraceDisplayMode.SortByTime.
                'traceSection.Mode = TraceDisplayMode.SortByTime


                ' Update if not locked.
                If Not traceSection.SectionInformation.IsLocked Then
                    configuration.Save()
                    Console.WriteLine("** Configuration updated.")
                Else
                    Console.WriteLine("** Could not update, section is locked.")
                End If
            Catch e As System.ArgumentException
                ' Unknown error.
                Console.WriteLine( _
                    "A invalid argument exception detected in UsingTraceSection Main. Check your")
                Console.WriteLine("command line for errors.")
            End Try
        End Sub
    End Class
    
End Namespace ' Samples.Aspnet.SystemWebConfiguration

Remarks

The TraceSection class provides a way to programmatically access and modify the content of the configuration file trace section. The trace section configures the ASP.NET trace functionality and controls how trace results are gathered, stored, and displayed.

When tracing is enabled, each page request generates trace messages that can be appended to the page output or stored in an application trace log. You can use the ASP.NET trace viewer (Trace.axd) to view the contents of the trace log.

Constructors

TraceSection()

Initializes a new instance of the TraceSection class using default settings.

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)
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)
Enabled	Gets or sets a value indicating whether the ASP.NET trace service is enabled.
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)
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)
LocalOnly	Gets or sets a value indicating whether the ASP.NET trace viewer (Trace.axd) is available only to requests from the host Web server.
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)
MostRecent	Gets or sets a value indicating whether the most recent requests are always stored on the server.
PageOutput	Gets or sets a value indicating whether the ASP.NET trace information is appended to the output of each page.
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RequestLimit	Gets or sets a value indicating the maximum number of requests to the application for which ASP.NET stores trace information.
SectionInformation	Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection)
TraceMode	Gets or sets the order in which ASP.NET trace information is displayed.
WriteToDiagnosticsTrace	Gets or sets a value indicating whether the messages emitted through the page trace are forwarded to an instance of the Trace class.

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

Deila með