ParseChildrenAttribute Constructor (Boolean)
Initializes a new instance of the ParseChildrenAttribute class using the ChildrenAsProperties property to determine if the elements that are contained within a server control are parsed as properties of the server control.
Assembly: System.Web (in System.Web.dll)
Parameters
- childrenAsProperties
-
Type:
System.Boolean
true to parse the elements as properties of the server control; otherwise, false.
If childrenAsProperties is false, the elements that are contained within the server control are parsed as a control. false is the default for ParseChildrenAttribute.
The code example in this section contains two parts. The first code example demonstrates how to set properties for the ParseChildrenAttribute class. The second code example demonstrates how to use classes in an ASP.NET page.
The following code example demonstrates how to set the ParseChildrenAttribute object for a custom server control named CollectionPropertyControl. When the ParseChildrenAttribute is declared before the class defining CollectionPropertyControl, the ParseChildrenAttribute sets the ChildrenAsProperties property to true.
using System; using System.Collections; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using System.Security.Permissions; namespace Samples.AspNet.CS.Controls { // Create a class that will be rendered as a child of the control // that has the ParseChildren attribute applied to it. [AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)] public sealed 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 this Boolean version of the ParseChildrenAttribute constructor // to set the ChildrenAsProperties property to true. Any properties of the // the CollectionPropertyControl custom control will be used as parsable // children. [ParseChildren(true)] [AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)] public sealed 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 = System.Drawing.Color.Beige; label.ForeColor = System.Drawing.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 = System.Drawing.Color.Beige; table.ForeColor = System.Drawing.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); } } }
The following code example demonstrates how to use the CollectionPropertyControl and Employee classes in an ASP.NET page. One instance of the Employee class is added declaratively and another is added programmatically.
<%@ Page Language="C#" %> <%@ Register TagPrefix="AspSample" Assembly="Samples.AspNet.CS.Controls" Namespace="Samples.AspNet.CS.Controls" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> protected void Page_Load(object sender, EventArgs e) { // Create a new employee object and add it to the custom control. Employee e1 = new Employee("Employee 2", "Title 2", "Alias 2"); CollectionPropertyControl1.Employees.Add(e1); // Verify attribute values. ParseChildrenAttribute p = (ParseChildrenAttribute)Attribute.GetCustomAttribute(typeof(CollectionPropertyControl), typeof(ParseChildrenAttribute)); StringBuilder sb = new StringBuilder(); sb.Append("The ChildControlType property is " + p.ChildControlType.ToString() + "<br />"); sb.Append("The ChildrenAsProperties property is " + p.ChildrenAsProperties.ToString() + "<br />"); sb.Append("The IsDefaultAttribute method returns " + p.IsDefaultAttribute().ToString()); Message.Text = sb.ToString(); } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ParseChildrenAttribute Example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:Label ID="Message" runat="server"/> <AspSample:CollectionPropertyControl id="CollectionPropertyControl1" runat="server"> <Employees> <AspSample:Employee Name="Employee 1" Title="Title 1" Alias="Alias 1" /> </Employees> </AspSample:CollectionPropertyControl> </div> </form> </body> </html>
Available since 1.1