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 ()
public boolean NeedsTagInnerText ()
public function NeedsTagInnerText () : boolean
Not applicable.

Return Value

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.

[AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
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.");
        else
            _innerText = text;
    }
}

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: