TransformerInfoCollection 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.

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

public ref class TransformerInfoCollection sealed : System::Configuration::ConfigurationElementCollection

[System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.TransformerInfo))]
public sealed class TransformerInfoCollection : System.Configuration.ConfigurationElementCollection

[<System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.TransformerInfo))>]
type TransformerInfoCollection = class
    inherit ConfigurationElementCollection

Public NotInheritable Class TransformerInfoCollection
Inherits ConfigurationElementCollection

Inheritance: Object

ConfigurationElement

ConfigurationElementCollection
TransformerInfoCollection

Attributes: ConfigurationCollectionAttribute

Examples

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();

' 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.
Dim ti As Integer
For ti = 0 To webPartsSection.Personalization.Providers.Count - 1
  Console.WriteLine("  #{0} Name={1} Type={2}", ti, _
    webPartsSection.Transformers(ti).Name, _
    webPartsSection.Transformers(ti).Type)
Next

' 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()

Remarks

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.

Constructors

TransformerInfoCollection()

Initializes a new instance of the TransformerInfoCollection class.

Properties

AddElementName	Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ClearElementName	Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
CollectionType	Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
Count	Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection)
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)
ElementName	Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EmitClear	Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection)
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)
IsSynchronized	Gets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[Int32]	Gets or sets the TagMapInfo object at the specified index location.
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)
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RemoveElementName	Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SyncRoot	Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
ThrowOnDuplicate	Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown. (Inherited from ConfigurationElementCollection)

Methods

Add(TransformerInfo)	Adds a TransformerInfo object to the collection.
BaseAdd(ConfigurationElement, Boolean)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseAdd(ConfigurationElement)	Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseClear()	Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection)
BaseGet(Int32)	Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection)
BaseGet(Object)	Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection)
BaseGetAllKeys()	Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseGetKey(Int32)	Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indicates the index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection)
BaseIsRemoved(Object)	Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseRemove(Object)	Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection)
BaseRemoveAt(Int32)	Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
Clear()	Removes all TransformerInfo objects from the collection.
CopyTo(ConfigurationElement[], Int32)	Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection)
CreateNewElement()	When overridden in a derived class, creates a new ConfigurationElement. (Inherited from ConfigurationElementCollection)
CreateNewElement(String)	Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Gets the element key for a specified configuration element when overridden in a derived class. (Inherited from ConfigurationElementCollection)
GetEnumerator()	Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
GetHashCode()	Gets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection)
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)
IsElementName(String)	Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsModified()	Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection)
IsReadOnly()	Indicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection)
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)	Causes the configuration system to throw an exception. (Inherited from ConfigurationElementCollection)
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)
Remove(String)	Removes the TransformerInfo object with the passed Name property value from the collection.
RemoveAt(Int32)	Removes the TransformerInfo object from the collection at the passed index.
Reset(ConfigurationElement)	Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ResetModified()	Resets the value of the IsModified() property to `false` when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
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 ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Reverses the effect of merging configuration information from different levels of the configuration hierarchy. (Inherited from ConfigurationElementCollection)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Share via