CreatePlaceHolderDesignTimeHtml Method (String)
.NET Framework Class Library
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)
Visual Basic (Declaration)
Protected Function CreatePlaceHolderDesignTimeHtml ( _
    instruction As String _
) As String
Visual Basic (Usage)
Dim instruction As String
Dim returnValue As String

returnValue = Me.CreatePlaceHolderDesignTimeHtml(instruction)
C#
protected string CreatePlaceHolderDesignTimeHtml(
    string instruction
)
Visual C++
protected:
String^ CreatePlaceHolderDesignTimeHtml(
    String^ instruction
)
JScript
protected function CreatePlaceHolderDesignTimeHtml(
    instruction : String
) : String

Parameters

instruction
Type: System..::.String
A string that contains text and markup to add to the HTML output.

Return Value

Type: System..::.String
A string that contains design-time HTML markup providing information about 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.

Visual Basic
' Add instructions to the placeholder view of the control
Public Overloads Overrides Function GetDesignTimeHtml() As String
    Return CreatePlaceHolderDesignTimeHtml("Click here and use " & _
        "the task menu to edit the templates.")
End Function
C#
// 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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
Page view tracker