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.

[Visual Basic]
Public Overridable Function NeedsTagInnerText() As Boolean
[C#]
public virtual bool NeedsTagInnerText();
[C++]
public: virtual bool NeedsTagInnerText();
[JScript]
public function NeedsTagInnerText() : Boolean;

Return Value

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

Remarks

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

Example

[Visual Basic] 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 method call 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.

[Visual Basic] 
Public Class MyControlControlBuilder
  Inherits ControlBuilder
    
    Private _innerText As String
    
    Overrides Public Function NeedsTagInnerText() As Boolean
      Return InDesigner
    End Function
    
    Overrides Public Sub SetTagInnerText(ByVal text As String)        
       If InDesigner = False
         Throw New System.Exception("The control is not in design mode.")
       Else
         _innerText = text
       End If
    End Sub
    
End Class

[C#, C++, JScript] No example is available for C#, C++, or JScript. To view a Visual Basic example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

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

See Also

ControlBuilder Class | ControlBuilder Members | System.Web.UI Namespace

Show: