ControlDesignerGetDesignTimeHtml Method

Retrieves the HTML markup that is used to represent the control at design time.

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

public virtual string GetDesignTimeHtml()
virtual String^ GetDesignTimeHtml()
abstract GetDesignTimeHtml : unit -> string
override GetDesignTimeHtml : unit -> string
Public Overridable Function GetDesignTimeHtml As String

Return Value


The HTML markup used to represent the control at design time.

Notes to Inheritors:

If you are creating a custom container control, make sure that you render the control and all child controls at design time, regardless of whether the property is set to true or false.


The following code example demonstrates how to override the GetDesignTimeHtml method in a custom control designer. If the Text property for the associated control is empty, the GetDesignTimeHtml method calls the GetEmptyDesignTimeHtml method. Otherwise, the GetDesignTimeHtml method creates and renders a Hyperlink control.

public override string GetDesignTimeHtml()
    if (simpleControl.Text.Length > 0)
        string spec = "<a href='{0}.aspx'>{0}</a>";
        return String.Format(spec, simpleControl.Text);
        return GetEmptyDesignTimeHtml();
Public Overrides Function GetDesignTimeHtml() As String
   ' Component is the instance of the component or control that
   ' this designer object is associated with. This property is 
   ' inherited from System.ComponentModel.ComponentDesigner.
   simpleControl = CType(Component, Simple)

   If simpleControl.Text.Length > 0 Then
      Dim sw As New StringWriter()
      Dim tw As New HtmlTextWriter(sw)

      Dim placeholderLink As New HyperLink()

      ' Put simpleControl.Text into the link's Text.
      placeholderLink.Text = simpleControl.Text
      placeholderLink.NavigateUrl = simpleControl.Text

      Return sw.ToString()
      Return GetEmptyDesignTimeHtml()
   End If
End Function
Version Information
.NET Framework
Available since 1.1
Return to top