Edit

Share via

ControlBuilder.InDesigner Property

  • Reference

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Returns whether the ControlBuilder is running in the designer.

protected:
 property bool InDesigner { bool get(); };
protected bool InDesigner { get; }
member this.InDesigner : bool
Protected ReadOnly Property InDesigner As Boolean

Property Value

Boolean

true if the ControlBuilder is running in the designer; otherwise, false.

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 method 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

Applies to