This documentation is archived and is not being maintained.

Control.AddParsedSubObject Method

Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)

'Declaration
Protected Overridable Sub AddParsedSubObject ( _
	obj As Object _
)
'Usage
Dim obj As Object

Me.AddParsedSubObject(obj)
protected void AddParsedSubObject (
	Object obj
)
protected function AddParsedSubObject (
	obj : Object
)
Not applicable.

Parameters

obj

An Object that represents the parsed element.

Unless you override it, this method automatically adds LiteralControl objects to the server control's ControlCollection object. This collection is accessible through Control.Controls property.

The following example is a custom server control that uses the AddParsedSubObject method to determine if elements declared between the opening and closing tags of this control are TextBox Web server controls. If they are, they are added to an ArrayList object, items. When the overridden CreateChildControls method is called, it iterates through the ArrayList and adds each object in it to the ControlCollection of the custom server control.

Security noteSecurity Note:

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview (Visual Studio).

' Custom ControlBuilder class. Interprets nested tag name "myitem" as a textbox.
Public Class MyControlBuilder
   Inherits ControlBuilder

   Public Overrides Function GetChildControlType(tagName As String, _
                             attributes As IDictionary) As Type
      If String.Compare(tagName, "myitem", True) = 0 Then
         Return GetType(TextBox)
      End If
      Return Nothing
   End Function
End Class

<ControlBuilderAttribute(GetType(MyControlBuilder))> Public Class MyControl
   Inherits Control
   ' Stores all the controls specified as nested tags.
   Private items As New ArrayList()

   ' This function is internally invoked by IParserAccessor.AddParsedSubObject(Object).
   Protected Overrides Sub AddParsedSubObject(obj As Object)
      If TypeOf obj Is TextBox Then
         items.Add(obj)
      End If
   End Sub

  ' Override 'CreateChildControls'.
   Protected Overrides Sub CreateChildControls()
      Dim myEnumerator As System.Collections.IEnumerator = items.GetEnumerator()
      While myEnumerator.MoveNext()
         Me.Controls.Add(CType(myEnumerator.Current, TextBox))
      End While
   End Sub
End Class

// Custom ControlBuilder class. Interprets nested tag name "myitem" as 
// a textbox. 
public class MyControlBuilder extends ControlBuilder
{
    public Type GetChildControlType(String tagName, IDictionary attributes)
    {
        if (String.Compare(tagName, "myitem", true) == 0) {
            return TextBox.class.ToType();
        }
        return null;
    } //GetChildControlType
} //MyControlBuilder

/** @attribute ControlBuilderAttribute(MyControlBuilder.class)
 */
public class MyControl extends Control
{
    // Store all the controls specified as nested tags.
    private ArrayList items = new ArrayList();

    // This function is internally invoked by 
    // IParserAccessor.AddParsedSubObject(Object).
    protected void AddParsedSubObject(Object obj)
    {
        if (obj instanceof TextBox) {
            items.Add(obj);
        }
    } //AddParsedSubObject

    // Override 'CreateChildControls'. 
    protected void CreateChildControls()
    {
        System.Collections.IEnumerator myEnumerator = items.GetEnumerator();
        while (myEnumerator.MoveNext()) {
            this.get_Controls().Add((TextBox)myEnumerator.get_Current());
        }
    } //CreateChildControls
} //MyControl 

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: