ControlBuilder.SetTagInnerText(String) Method

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides the ControlBuilder with the inner text of the control tag.

public:
 virtual void SetTagInnerText(System::String ^ text);

public virtual void SetTagInnerText (string text);

abstract member SetTagInnerText : string -> unit
override this.SetTagInnerText : string -> unit

Public Overridable Sub SetTagInnerText (text As String)

Parameters

text: String

The text to be provided.

Examples

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;
    }
}

<AspNetHostingPermission(SecurityAction.Demand, _
  Level:=AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable 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

Remarks

This method is called only if NeedsTagInnerText previously returned true.

Applies to

Dela via