This documentation is archived and is not being maintained.

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 ()
public String GetDesignTimeHtml ()
public function GetDesignTimeHtml () : String
Not applicable.

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: