This documentation is archived and is not being maintained.

ControlDesigner.CreatePlaceHolderDesignTimeHtml Method (String)

Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information.

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

protected string CreatePlaceHolderDesignTimeHtml (
	string instruction
)
protected String CreatePlaceHolderDesignTimeHtml (
	String instruction
)
protected function CreatePlaceHolderDesignTimeHtml (
	instruction : String
) : String
Not applicable.

Parameters

instruction

A string that contains text and markup to add to the HTML output.

Return Value

A string that contains design-time HTML markup providing information about the control.

Notes to Inheritors: The typical design pattern is to try to get HTML markup through the associated control, and then if an error is encountered, call the GetErrorDesignTimeHtml method. If no markup is returned by the control, call the GetEmptyDesignTimeHtml method, which if it is not overridden to provide specific markup, calls the CreatePlaceHolderDesignTimeHtml method, which should contain information about the type and ID of the control.

The following code example demonstrates how to override the GetDesignTimeHtml method in a templated control designer. A string is then passed as the instruction parameter in a call to the CreatePlaceHolderDesignTimeHtml method, which provides the design-time HTML markup.

This code example is part of a larger example provided for the TemplateGroups property.

// Add instructions to the placeholder view of the control
public override string GetDesignTimeHtml()
{
    return CreatePlaceHolderDesignTimeHtml("Click here and use " +
        "the task menu to edit the templates.");
}

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: