ControlBuilder Class

.NET Framework (current version)

Supports the page parser in building a control and the child controls it contains.

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

Inheritance Hierarchy

Syntax

C++

public ref class ControlBuilder

Constructors

	Name	Description
	ControlBuilder()	Initializes a new instance of the ControlBuilder class.

Properties

	Name	Description
	BindingContainerBuilder
	BindingContainerType	Gets the type of the binding container for the control that this builder creates.
	ComplexPropertyEntries	Gets a collection of complex property entries.
	ControlType	Gets the Type for the control to be created.
	CurrentFilterResolutionService	Gets an IFilterResolutionService object that is used to manage device-filter related services when parsing and persisting controls in the designer.
	DeclareType	Gets the type that will be used by code generation to declare the control.
	FChildrenAsProperties	Gets a value that determines whether the control has a ParseChildrenAttribute with ChildrenAsProperties set to true.
	FIsNonParserAccessor	Gets a value that determines whether the control implements the IParserAccessor interface.
	HasAspCode	Gets a value indicating whether the control contains any code blocks.
	ID	Gets or sets the identifier property for the control to be built.
	InDesigner	Returns whether the ControlBuilder is running in the designer.
	InPageTheme	Gets a Boolean value indicating whether this ControlBuilder object is used to generate page themes.
	ItemType	Gets the type set on the binding container.
	Localize	Gets a Boolean value indicating whether the control that is created by this ControlBuilder object is localized.
	NamingContainerType	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the type of the naming container for the control that this builder creates.
	PageVirtualPath	Gets the virtual path of a page to be built by this ControlBuilder instance.
	Parser	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the TemplateParser responsible for parsing the control.
	ServiceProvider	Gets the service object for this ControlBuilder object.
	SubBuilders	Gets a list of child ControlBuilder objects for this ControlBuilder object.
	TagName	Gets the tag name for the control to be built.
	TemplatePropertyEntries	Gets a collection of template property entries.
	ThemeResolutionService	Gets an IThemeResolutionService object that is used in design time to manage control themes and skins.

Methods

	Name	Description
	AllowWhitespaceLiterals()	Determines whether white space literals are permitted in the content between a control's opening and closing tags. This method is called by the ASP.NET page framework.
	AppendLiteralString(String^)	Adds the specified literal content to a control. This method is called by the ASP.NET page framework.
	AppendSubBuilder(ControlBuilder^)	Adds builders to the ControlBuilder object for any child controls that belong to the container control.
	BuildObject()	Builds a design-time instance of the control that is referred to by this ControlBuilder object.
	CloseControl()	Called by the parser to inform the builder that the parsing of the control's opening and closing tags is complete.
	CreateBuilderFromType(TemplateParser^, ControlBuilder^, Type^, String^, String^, IDictionary^, Int32, String^)	Creates a ControlBuilder object from the specified tag name and object type, as well as other parameters defining the builder.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetChildControlType(String^, IDictionary^)	Obtains the Type of the control type corresponding to a child tag. This method is called by the ASP.NET page framework.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetObjectPersistData()	Creates the ObjectPersistData object for this ControlBuilder object.
	GetResourceKey()	This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the resource key for this ControlBuilder object.
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	HasBody()	Determines if a control has both an opening and closing tag. This method is called by the ASP.NET page framework.
	HtmlDecodeLiterals()	Determines whether the literal string of an HTML control must be HTML decoded. This method is called by the ASP.NET page framework.
	Init(TemplateParser^, ControlBuilder^, Type^, String^, String^, IDictionary^)	Initializes the ControlBuilder for use after it is instantiated. This method is called by the ASP.NET page framework.
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	NeedsTagInnerText()	Determines if the control builder needs to get its inner text. If so, the SetTagInnerText method must be called. This method is called by the ASP.NET page framework.
	OnAppendToParentBuilder(ControlBuilder^)	Notifies the ControlBuilder that it is being added to a parent control builder.
	ProcessGeneratedCode(CodeCompileUnit^, CodeTypeDeclaration^, CodeTypeDeclaration^, CodeMemberMethod^, CodeMemberMethod^)	Enables custom control builders to access the generated Code Document Object Model (CodeDom) and insert and modify code during the process of parsing and building controls.
	SetResourceKey(String^)	This API supports the product infrastructure and is not intended to be used directly from your code. Sets the resource key for this ControlBuilder object.
	SetServiceProvider(IServiceProvider^)	This API supports the product infrastructure and is not intended to be used directly from your code. Sets the service object for this ControlBuilder object.
	SetTagInnerText(String^)	Provides the ControlBuilder with the inner text of the control tag.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Fields

	Name	Description
	DesignerFilter	Represents the "__designer" literal string.

By default, every control on a page is associated with a default ControlBuilder class. During parsing, the ASP.NET page framework builds a tree of ControlBuilder objects corresponding to the tree of controls for the page. The ControlBuilder tree is then used to generate page code to create the control tree. In addition to child controls, the ControlBuilder defines the behavior of how the content within control tags is parsed. You can override this default behavior by defining your own custom control builder class. This is done by applying a ControlBuilderAttribute attribute to your control builder class as follows:

[ControlBuilderAttribute(typeof(ControlBuilderType))]

Examples

The following code example creates a Table control whose attributes and content are defined at the time the table is built. The following is the command line to use to build the executable.

[Visual Basic]

vbc /r:System.dll /r:System.Web.dll /r:System.Drawing.dll /t:library /out:myWebAppPath/Bin/vb_mycontrolbuilder.dll myControlBuilder.vb

[C#]

csc /t:library /out:myWebAppPath/Bin/cs_mycontrolbuilder.dll myControlBuilder.cs

C++

No code example is currently available or this language may not be supported.

The following code example uses the previous custom control. In particular, it builds a table whose attributes and content are defined at run time. Notice that the values shown in the directive reflect the previous command line.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 1.1

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.