ControlDesignerGetDesignTimeHtml Method
 

Retrieves the HTML markup to display the control and populates the collection with the current control designer regions.

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

Syntax
public virtual string GetDesignTimeHtml(
	DesignerRegionCollection regions
)
public:
virtual String^ GetDesignTimeHtml(
	DesignerRegionCollection^ regions
)
abstract GetDesignTimeHtml : 
        regions:DesignerRegionCollection -> string
override GetDesignTimeHtml : 
        regions:DesignerRegionCollection -> string
Public Overridable Function GetDesignTimeHtml (
	regions As DesignerRegionCollection
) As String

Parameters

regions
Type:

A collection of control designer regions for the associated control.

Return Value

Type:

The design-time HTML markup for the associated control, including all control designer regions.

Remarks

The design host calls the GetDesignTimeHtml method to get the design-time HTML markup and the current list of control designer regions. Using the DesignerRegionCollection, the design host can then request the markup for each editable control designer region.

The GetDesignTimeHtml method is provided for a derived control designer, such as the GridViewDesigner class, that must process the content for the region before calling the GetDesignTimeHtml method.

Examples

The following code example shows how to create HTML markup using the DesignerRegionCollection collection.

// Create the regions and design-time markup. Called by the designer host.
public override String GetDesignTimeHtml(DesignerRegionCollection regions) {
    // Create 3 regions: 2 clickable headers and an editable row
    regions.Add(new DesignerRegion(this, "Header0"));
    regions.Add(new DesignerRegion(this, "Header1"));

    // Create an editable region and add it to the regions
    EditableDesignerRegion editableRegion = 
        new EditableDesignerRegion(this, 
            "Content" + myControl.CurrentView, false);
    regions.Add(editableRegion);

    // Set the highlight for the selected region
    regions[myControl.CurrentView].Highlight = true;

    // Use the base class to render the markup
    return base.GetDesignTimeHtml();
}
' Create the regions and design-time markup. Called by the designer host.
Public Overrides Function GetDesignTimeHtml(ByVal regions As DesignerRegionCollection) As String
    ' Create 3 regions: 2 clickable headers and an editable row
    regions.Add(New DesignerRegion(Me, "Header0"))
    regions.Add(New DesignerRegion(Me, "Header1"))

    ' Create an editable region and add it to the regions
    Dim editableRegion As EditableDesignerRegion = _
        New EditableDesignerRegion(Me, _
            "Content" & myControl.CurrentView, False)
    regions.Add(editableRegion)

    ' Set the highlight for the selected region
    regions(myControl.CurrentView).Highlight = True

    ' Use the base class to render the markup
    Return MyBase.GetDesignTimeHtml()
End Function
Version Information
.NET Framework
Available since 2.0
Return to top