This documentation is archived and is not being maintained.

ControlBuilder.NeedsTagInnerText Method

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.

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

public virtual bool NeedsTagInnerText()

Return Value

Type: System.Boolean
true if the control builder needs to get its inner text. The default is false.

The inner text is the text between the opening and closing tags of the control.

This method is called by the ASP.NET page framework during parsing and is not intended to be called directly in you code.

The following example uses the InDesigner property when the NeedsTagInnerText method is called. When a control has this builder attached to it, the NeedsTagInnerText determines whether the control is being accessed at design-time through a designer. The NeedsTagInnerText returns the value of the InDesigner property, and then the SetTagInnerText method is called. If the InDesigner property is set to false, an Exception is thrown. Otherwise, the inner text of the control is returned on the SetTagInnerText call.

	public sealed class MyControlControlBuilder : ControlBuilder
		private string _innerText;

		public override bool NeedsTagInnerText()
			return InDesigner;

		public override void SetTagInnerText(string text)
			if (!InDesigner)
				throw new Exception("The control is not in design mode.");
				_innerText = text;

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.