Export (0) Print
Expand All

TransformerInfo Class

Specifies a custom class that extends the WebPartTransformer class for use by Web Part connections.

System.Object
  System.Configuration.ConfigurationElement
    System.Web.Configuration.TransformerInfo

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public sealed class TransformerInfo : ConfigurationElement

The TransformerInfo type exposes the following members.

  NameDescription
Public methodTransformerInfoInitializes a new instance of the TransformerInfo class with the specified name and type reference.
Top

  NameDescription
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public propertyNameGets or sets a friendly name for a type that that extends the WebPartTransformer class.
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyTypeGets or sets the type reference for a class that extends the WebPartTransformer class.
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current TransformerInfo object to another TransformerInfo object. (Overrides ConfigurationElement.Equals(Object).)
Public methodGetHashCodeGenerates a hash code for the collection. (Overrides ConfigurationElement.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

TransformerInfo objects specify custom classes that extend the WebPartTransformer class. These custom transformer classes act as bridges between Web Parts, translating data between Web Parts with incompatible connection points.

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

<system.web>
  <webParts>
    <transformers>
      <add name="RowToFieldTransformer"
        type="System.Web.UI.WebControls.WebParts.RowToFieldTransformer" />
      <add name="RowToFilterTransformer"
        type="System.Web.UI.WebControls.WebParts.RowToFilterTransformer" />
      <add name="RowToParametersTransformer"
        type="System.Web.UI.WebControls.WebParts.RowToParametersTransformer" />
    </transformers>
  </webParts> 
</system.web>

The following code example shows how to use the TransformerInfo class. This code example is part of a larger example provided for the WebPartsSection class.

// Add a Transfomer Info Object to the collection using a constructor.
webPartsSection.Transformers.Add(new TransformerInfo(
	"RowToFilterTransformer",
	"MyCustomTransformers.RowToFilterTransformer"));

// Show all TransformerInfo objects in the collection. 
for (int ti = 0;
	ti < webPartsSection.Personalization.Providers.Count; ti++)
{
	Console.WriteLine("  #{0} Name={1} Type={2}", ti,
		webPartsSection.Transformers[ti].Name,
		webPartsSection.Transformers[ti].Type);
}

// Remove a TransformerInfo object by name.
webPartsSection.Transformers.Remove("RowToFilterTransformer");

// Remove a TransformerInfo object by index.
webPartsSection.Transformers.RemoveAt(0);

// Clear all TransformerInfo objects from the collection.
webPartsSection.Transformers.Clear();

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft