This documentation is archived and is not being maintained.

PersistChildrenAttribute Class

Defines a metadata attribute used by ASP.NET server controls. The attribute indicates whether, at design time, the child controls of an ASP.NET server control should be persisted as nested inner controls. This class cannot be inherited.

For a list of all members of this type, see PersistChildrenAttribute Members.

System.Object
   System.Attribute
      System.Web.UI.PersistChildrenAttribute

[Visual Basic]
<AttributeUsage(AttributeTargets.Class)>
NotInheritable Public Class PersistChildrenAttribute
   Inherits Attribute
[C#]
[AttributeUsage(AttributeTargets.Class)]
public sealed class PersistChildrenAttribute : Attribute
[C++]
[AttributeUsage(AttributeTargets::Class)]
public __gc __sealed class PersistChildrenAttribute : public
   Attribute
[JScript]
public
   AttributeUsage(AttributeTargets.Class)
class PersistChildrenAttribute extends Attribute

Thread Safety

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

Remarks

If this attribute is true, the child controls of the ASP.NET server control are persisted as nested server control tags. If false, properties of the control are persisted as nested elements.

For more information about using attributes, see Extending Metadata Using Attributes.

Example

[Visual Basic] 
' Create a namespace that defines two classes, one a custom control, Employee,
' which is created for every instance of a child element with its name
' declared in a page associated with this namespace, the other, Employees,
' which contains these child elements.
Imports System
Imports System.Collections
Imports System.Drawing
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace PersistChildrenSampleVB

' Create a class that will be rendered as a child of the control
' that has the ParseChildren attribute applied to it.
 Public Class Employee
   Private _name As String
   Private _title As String
   Private _alias As String
   
   
   Public Sub New()
      Me.New("", "", "")
   End Sub 'New

    
   Public Sub New(name As String, title As String, employeeAlias As String)
      Me._name = name
      Me._title = title
      Me._alias = employeeAlias
   End Sub 'New
   
   Public Property Name() As String
      Get
         Return _name
      End Get
      Set
         _name = value
      End Set
   End Property
   
   
   Public Property Title() As String
      Get
         Return _title
      End Get
      Set
         _title = value
      End Set
   End Property
   
   
   Public Property [Alias]() As String
      Get
         Return _alias
      End Get
      Set
         _alias = value
      End Set
   End Property
End Class 'Employee

 ' Use the PersistChildren attribute to set the Persist
 ' property to false so that none of this class's
 ' child controls will be persisted as controls. They will
 ' be persisted only as child elements of this class.
 ' If you set the PersistChildren attribute to true, or if you
 ' do not include this attribute when you create a control,
 ' the child controls will be persisted as controls.
 <PersistChildren(False)>  _
 Public Class CollectionPropertyControl
   Inherits Control
   Private _header As String
   Private _employees As New ArrayList()
   
   
   Public Property Header() As String
      Get
         Return _header
      End Get
      Set
         _header = value
      End Set
   End Property
   
   
   
   
   Public ReadOnly Property Employees() As ArrayList
      Get
         Return _employees
      End Get
   End Property
   
   ' Override the CreateChildControls method to 
   ' add child controls to the Employees property when this
   ' custom control is requested from a page.
   Protected Overrides Sub CreateChildControls()
      Dim label As New Label()
      label.Text = Header
      label.BackColor = Color.Beige
      label.ForeColor = Color.Red
      Controls.Add(label)
      Controls.Add(New LiteralControl("<BR> <BR>"))
      
      Dim table As New Table()
      Dim htr As New TableRow()
      
      Dim hcell1 As New TableHeaderCell()
      hcell1.Text = "Name"
      htr.Cells.Add(hcell1)
      
      Dim hcell2 As New TableHeaderCell()
      hcell2.Text = "Title"
      htr.Cells.Add(hcell2)
      
      Dim hcell3 As New TableHeaderCell()
      hcell3.Text = "Alias"
      htr.Cells.Add(hcell3)
      table.Rows.Add(htr)
      
      table.BorderWidth = Unit.Pixel(2)
      table.BackColor = Color.Beige
      table.ForeColor = Color.Red
      Dim employee As Employee
      For Each employee In  Employees
         Dim tr As New TableRow()
         
         Dim cell1 As New TableCell()
         cell1.Text = employee.Name
         tr.Cells.Add(cell1)
         
         Dim cell2 As New TableCell()
         cell2.Text = employee.Title
         tr.Cells.Add(cell2)
         
         Dim cell3 As New TableCell()
         cell3.Text = employee.Alias
         tr.Cells.Add(cell3)
         
         table.Rows.Add(tr)
      Next employee
      Controls.Add(table)
   End Sub 'CreateChildControls 
 End Class 'CollectionPropertyControl
End Namespace ' PersistChildrenSampleVB

[C#] 
using System;
using System.Collections;
using System.Drawing;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace PersistChildrenSamples
{
   // The child element class.
   public class Employee
   {
      private String name;
      private String title;
      private String alias;

      public Employee():this ("","",""){}
      
      public Employee (String name, String title, String alias)
      {
         this.name = name;
         this.title = title;
         this.alias = alias;
      }
      public String Name
      {
         get
         {
            return name;
         }
         set
         {
            name = value;
         }
      }
      
      public String Title
      {
         get
         {
            return title;
         }
         set
         {
            title = value;
         }
      }
      
      public String Alias
      {
         get
         {
            return alias;
         }
         set
         {
            alias = value;
         }
      }
   }
   // Use the PersistChildren attribute to set the Persist
   // property to false so that none of this class's
   // child controls will be persisted as controls. They will
   // be persisted only as child elements of this class.
   // If you set the PersistChildren attribute to true, or if you
   // do not include this attribute when you create a control,
   // the child controls will be persisted as controls.   
   [PersistChildren(false)]
   public class CollectionPropertyControl : Control
   {  
      private String header;
      private ArrayList employees = new ArrayList();
      
      public String Header
      {
         get
         {
            return header;
         }
         set
         {
            header = value;
         }
      }


      
      public ArrayList Employees
      {
         get 
         {
            return employees;
         }
      }
      // Override the CreateChildControls method to 
      // add child controls to the Employees property when this
      // custom control is requested from a page.
      protected override void CreateChildControls()
      {
         Label label = new Label();
         label.Text = Header;
         label.BackColor = Color.Beige;
         label.ForeColor = Color.Red;
         Controls.Add(label);
         Controls.Add(new LiteralControl("<BR> <BR>"));

         Table table = new Table();
         TableRow htr = new TableRow();

         TableHeaderCell hcell1 = new TableHeaderCell();    
         hcell1.Text = "Name";
         htr.Cells.Add(hcell1);

         TableHeaderCell hcell2 = new TableHeaderCell();
         hcell2.Text = "Title";
         htr.Cells.Add(hcell2);
         
         TableHeaderCell hcell3 = new TableHeaderCell();
         hcell3.Text = "Alias";
         htr.Cells.Add(hcell3);
         table.Rows.Add(htr);

         table.BorderWidth = 2;
         table.BackColor = Color.Beige;
         table.ForeColor = Color.Red;
         foreach (Employee employee in Employees)
         {
            TableRow tr = new TableRow();

            TableCell cell1 = new TableCell();
            cell1.Text = employee.Name;
            tr.Cells.Add(cell1);
            
            TableCell cell2 = new TableCell();
            cell2.Text = employee.Title;
            tr.Cells.Add(cell2);
            
            TableCell cell3 = new TableCell();
            cell3.Text = employee.Alias;
            tr.Cells.Add(cell3);
            
            table.Rows.Add(tr);
         }
         Controls.Add(table);
         
      }
   }
}

[C++] 
#using <mscorlib.dll>
#using <System.dll>
#using <System.Drawing.dll>
#using <System.Web.dll>
using namespace System;
using namespace System::Collections;
using namespace System::Drawing;
using namespace System::Web;
using namespace System::Web::UI;
using namespace System::Web::UI::WebControls;

// The child element class.
public __gc class Employee {
private:
   String*  name;
   String*  title;
   String*  alias;

public:
   Employee() :name(S""), title (S""), alias(S"") {}

public:
   Employee (String* name, String* title, String* alias) {
      this->name = name;
      this->title = title;
      this->alias = alias;
   }
public:
   __property String* get_Name() {
      return name;
   }
   __property void set_Name(String* value) {
      name = value;
   }


public:
   __property String* get_Title() {
      return title;
   }
   __property void set_Title(String* value) {
      title = value;
   }


public:
   __property String* get_Alias() {
      return alias;
   }
   __property void set_Alias(String* value) {
      alias = value;
   }

};
// Use the PersistChildren attribute to set the Persist
// property to false so that none of this class's
// child controls will be persisted as controls. They will
// be persisted only as child elements of this class.
// If you set the PersistChildren attribute to true, or if you
// do not include this attribute when you create a control,
// the child controls will be persisted as controls.
[PersistChildren(false)]
public __gc class CollectionPropertyControl : public Control {
private:
   String*  header;
private:
   ArrayList* employees;

public:

   CollectionPropertyControl()
   {
      employees = new ArrayList();
   }
   __property String* get_Header() {
      return header;
   }
   __property void set_Header(String* value) {
      header = value;
   }


public:
   __property ArrayList* get_Employees() {
      return employees;
   }

   // Override the CreateChildControls method to
   // add child controls to the Employees property when this
   // custom control is requested from a page.
protected:
   void CreateChildControls() {
      Label* label = new Label();
      label->Text = Header;
      label->BackColor = Color::Beige;
      label->ForeColor = Color::Red;
      Controls->Add(label);
      Controls->Add(new LiteralControl(S"<BR> <BR>"));

      Table* table = new Table();
      TableRow* htr = new TableRow();

      TableHeaderCell* hcell1 = new TableHeaderCell();
      hcell1->Text = S"Name";
      htr->Cells->Add(hcell1);

      TableHeaderCell* hcell2 = new TableHeaderCell();
      hcell2->Text = S"Title";
      htr->Cells->Add(hcell2);

      TableHeaderCell* hcell3 = new TableHeaderCell();
      hcell3->Text = S"Alias";
      htr->Cells->Add(hcell3);
      table->Rows->Add(htr);

      table->BorderWidth = 2;
      table->BackColor = Color::Beige;
      table->ForeColor = Color::Red;
      IEnumerator* myEnum = Employees->GetEnumerator();
      while (myEnum->MoveNext()) {
         Employee* employee = __try_cast<Employee*>(myEnum->Current);

         TableRow* tr = new TableRow();

         TableCell* cell1 = new TableCell();
         cell1->Text = employee->Name;
         tr->Cells->Add(cell1);

         TableCell* cell2 = new TableCell();
         cell2->Text = employee->Title;
         tr->Cells->Add(cell2);

         TableCell* cell3 = new TableCell();
         cell3->Text = employee->Alias;
         tr->Cells->Add(cell3);

         table->Rows->Add(tr);
      }
      Controls->Add(table);

   }
};

[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

Namespace: System.Web.UI

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

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

See Also

PersistChildrenAttribute Members | System.Web.UI Namespace | Attribute

Show: