.NET Framework Class Library
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)
Syntax
Public Overridable Function GetDesignTimeHtml As [%$TOPIC/ew7620aw_en-us_VS_110_1_0_0_0_0%]
public virtual [%$TOPIC/ew7620aw_en-us_VS_110_1_0_1_0_0%] GetDesignTimeHtml()
public:
virtual [%$TOPIC/ew7620aw_en-us_VS_110_1_0_2_0_0%]^ GetDesignTimeHtml()
abstract GetDesignTimeHtml : unit -> [%$TOPIC/ew7620aw_en-us_VS_110_1_0_3_0_0%]  
override GetDesignTimeHtml : unit -> [%$TOPIC/ew7620aw_en-us_VS_110_1_0_3_0_1%]

Return Value

Type: SystemString
The HTML markup used to represent the control at design time.
Remarks

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 Visible property is set to true or false.

Examples

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 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
      placeholderLink.RenderControl(tw)

      Return sw.ToString()
   Else 
      Return GetEmptyDesignTimeHtml()
   End If 
End Function
public override string GetDesignTimeHtml()
{
    if (simpleControl.Text.Length > 0)
    {
        string spec = "<a href='{0}.aspx'>{0}</a>";
        return String.Format(spec, simpleControl.Text);
    }
    else 
        return GetEmptyDesignTimeHtml();
}
Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Security
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.