Export (0) Print
Expand All

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.

[Visual Basic]
Protected Overridable Sub AddParsedSubObject( _
   ByVal obj As Object _
)
[C#]
protected virtual void AddParsedSubObject(
 object obj
);
[C++]
protected: virtual void AddParsedSubObject(
 Object* obj
);
[JScript]
protected function AddParsedSubObject(
   obj : Object
);

Parameters

obj
An Object that represents the parsed element.

Remarks

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.

Example

[Visual Basic, C#, C++] 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.

[Visual Basic] 
' 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

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

[ 
ControlBuilderAttribute(typeof(MyControlBuilder)) 
]
public class MyControl : Control
{
   // Store all the controls specified as nested tags.
   private ArrayList items = new ArrayList();
   
   // This function is internally invoked by IParserAccessor.AddParsedSubObject(Object).
   protected override void AddParsedSubObject(Object obj) 
   {
      if (obj is TextBox) 
      {
         items.Add(obj);
      }
   }

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

[C++] 
// Custom ControlBuilder class. Interprets nested tag name "myitem" as a textbox.
public __gc class MyControlBuilder : public ControlBuilder
{
public:
   Type* GetChildControlType(String* tagName, IDictionary* /*attributes*/)
   {
      if (String::Compare(tagName, S"myitem", true) == 0)
      {
         return __typeof(TextBox);
      }
      return 0;
   }
};

[
   ControlBuilderAttribute(__typeof(MyControlBuilder))
]
public __gc class MyControl : public Control
{
   // Store all the controls specified as nested tags.
private:
   ArrayList* items;

public:
   MyControl()
   {
      items = new ArrayList();
   }

   // This function is internally invoked by IParserAccessor.AddParsedSubObject(Object).
protected:
   void AddParsedSubObject(Object* obj)
   {
      if (dynamic_cast<TextBox*>(obj))
      {
         items->Add(obj);
      }
   }

   // Override 'CreateChildControls'.
   void CreateChildControls()
   {
      System::Collections::IEnumerator* myEnumerator = items->GetEnumerator();
      while(myEnumerator->MoveNext())
         this->Controls->Add(dynamic_cast<TextBox*>(myEnumerator->Current));
   }
};

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

Control Class | Control Members | System.Web.UI Namespace | ControlCollection

Show:
© 2014 Microsoft