Converter Class

Definition

Namespace:

System.Web.Configuration

Assembly:

System.Web.Extensions.dll

Represents a configuration element in a configuration file.

public ref class Converter : System::Configuration::ConfigurationElement

public class Converter : System.Configuration.ConfigurationElement

type Converter = class
    inherit ConfigurationElement

Public Class Converter
Inherits ConfigurationElement

Inheritance

Object

ConfigurationElement

Converter

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.

// 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];
}

' 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

Remarks

The Converter class enables you to programmatically access and modify the configuration settings related to converters that are used by AJAX-enabled ASP.NET 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.

Constructors

Converter()

Initializes a new instance of the Converter class.

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)
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)
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)
Name	Gets or sets the unique identifier for the converter.
Properties	Gets a collection of configuration-element properties.
Type	Gets or sets the fully qualified type name of the JavaScriptConverter object.

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
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)
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 ConfigurationElement)
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 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)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

See also

• JavaScriptConverter