Documentation for: ASP.NET Ajax Version 1.0

This documentation is for a previous version. For the current released version, see the ASP.NET Ajax documentation on MSDN.

 

 

 

 

 

 

 

Converter Class

Represents a configuration element in a configuration file.

Syntax

CSharp

VisualBasic

<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class Converter _
	Inherits ConfigurationElement

ManagedCPlusPlus

[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class Converter : public ConfigurationElement

JSharp

/** @attribute AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public class Converter extends ConfigurationElement

Members

IconMemberDescription
ConverterNew()Initializes a new instance of the Converter class.
DeserializeElement(XmlReader, Boolean)Reads XML from the configuration file. (Inherited from ConfigurationElement.)
ElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
ElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Equals(Object)Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
EvaluationContextGets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Finalize()Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCode()Gets a unique value representing the current ConfigurationElement instance. (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 ConfigurationElement.)
IsReadOnly()Gets a value indicating whether the ConfigurationElement object is read-only. (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.)
ListErrors(IList)Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
LockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
LockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
LockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
LockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
LockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
MemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
NameGets or sets the unique identifier for the converter.
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.)
PropertiesGets a collection of configuration-element properties. (Overrides ConfigurationElement.Properties.)
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 ConfigurationElement.)
SerializeElement(XmlWriter, Boolean)Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
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.)
ToString()Returns a String that represents the current Object. (Inherited from Object.)
TypeGets or sets the fully qualified type name of the JavaScriptConverter object.
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

Remarks

The Converter class enables you to programmatically access and modify the configuration settings related to converters used by Microsoft ASP.NET AJAX applications.

To create custom conversion functionality, you can create a class that inherits from the JavaScriptConverter class. After the converter has been created, you can register it for use in the configuration file of your Web application.

Examples

The following configuration file excerpt shows how to declaratively specify values for properties of the Converter class.

<system.web.extensions>
  <scripting>
    <webServices>
      <jsonSerialization>
        <converters>
          <add name="ConvertMe" type="Acme.SubAcme.ConvertMeTypeConverter" />
        </converters>
      </jsonSerialization>
    </webServices>
  </scripting>
</system.web.extensions>

The following example demonstrates how to access Converter programmatically.

App_Code

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

// Get the external JSON section.
ScriptingJsonSerializationSection jsonSection =
    (ScriptingJsonSerializationSection)configuration.GetSection(
    "system.web.extensions/scripting/webServices/jsonSerialization");

//Get the converters collection.
ConvertersCollection converters =
    jsonSection.Converters;

if ((converters != null) && converters.Count > 0)
{
    // Get the first registered converter.
    Converter converterElement = converters[0];
}

App_Code

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

' Get the external JSON section.
Dim jsonSection As ScriptingJsonSerializationSection = _
    CType(configuration.GetSection( _
        "system.web.extensions/scripting/webServices/jsonSerialization"), _
        ScriptingJsonSerializationSection)

'Get the converters collection.
Dim converters As ConvertersCollection = _
    jsonSection.Converters

If Not (converters Is Nothing) AndAlso _
    converters.Count > 0 Then
    ' Get the first registered converter.
    Dim converterElement As Converter = converters(0)
End If


Permissions

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: LinkDemand. Associated enumeration: Minimal.

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: InheritanceDemand. Associated enumeration: Minimal.

Inheritance Hierarchy

Assembly: System.Web.Extensions (Module: System.Web.Extensions)