ControlDesigner.GetDesignTimeHtml 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()

Return Value

Type: System.String
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 Visible 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);
    }
    else 
        return GetEmptyDesignTimeHtml();
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft