Export (0) Print
Expand All

TransformerInfoCollection Class

Contains a collection of TransformerInfo objects. This class cannot be inherited.

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

[ConfigurationCollectionAttribute(typeof(TransformerInfo))]
public sealed class TransformerInfoCollection : ConfigurationElementCollection

The TransformerInfoCollection class allows you to programmatically access and modify the transformers section of the webParts section of a configuration file.

TransformerInfo objects, as part of a TransformerInfoCollection, specify custom classes that extend the WebPartTransformer class. These transformer classes act as bridges between connected Web Parts, translating data sent by a connection provider into something that the connection consumer can accept.

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

<system.web>
  <webParts>
    <transformers>
      <clear />
      <remove name="RowToKeysTransformer" />
      <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 TransformerInfoCollection 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();

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft