.NET Framework Class Library
ControlDesignerGetEditableDesignerRegionContent Method

Returns the content for an editable region of the design-time view of the associated control.

Namespace:   System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)
Syntax
Public Overridable Function GetEditableDesignerRegionContent ( _
	region As [%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_0_0_0%] _
) As [%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_0_0_1%]
public virtual [%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_1_0_0%] GetEditableDesignerRegionContent(
	[%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_1_0_1%] region
)
public:
virtual [%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_2_0_0%]^ GetEditableDesignerRegionContent(
	[%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_2_0_1%]^ region
)
abstract GetEditableDesignerRegionContent : 
        region:[%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_3_0_0%] -> [%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_3_0_1%]  
override GetEditableDesignerRegionContent : 
        region:[%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_3_0_2%] -> [%$TOPIC/b4ab1d0h_en-us_VS_110_1_0_3_0_3%]

Parameters

region
Type: System.Web.UI.DesignEditableDesignerRegion

The EditableDesignerRegion object to get content for.

Return Value

Type: SystemString
The persisted content for the region, if the control designer supports editable regions; otherwise, an empty string ("").
Remarks

The default implementation of the GetEditableDesignerRegionContent method returns an empty string ("").

Classes deriving from the ControlDesigner class can support region-based editing on the design surface and override the GetEditableDesignerRegionContent method to return the content for a specified region.

Examples

The following code example shows how to get a reference to the design host, and then use the reference to create a ControlParser object that creates the HTML markup for region and its contents.

' Get the content string for the selected region. Called by the designer host? 
Public Overrides Function GetEditableDesignerRegionContent(ByVal region As EditableDesignerRegion) As String 
    ' Get a reference to the designer host 
    Dim host As IDesignerHost = CType(Component.Site.GetService(GetType(IDesignerHost)), IDesignerHost)

    If Not IsNothing(host) Then 
        Dim template As ITemplate = myControl.View1
        If region.Name = "Content1" Then
            template = myControl.View2
        End If 

        ' Persist the template in the design host 
        If Not IsNothing(template) Then 
            Return ControlPersister.PersistTemplate(template, host)
        End If 
    End If 

    Return String.Empty
End Function
// Get the content string for the selected region. Called by the designer host? 
public override string GetEditableDesignerRegionContent(EditableDesignerRegion region) 
{
    // Get a reference to the designer host
    IDesignerHost host = (IDesignerHost)Component.Site.GetService(typeof(IDesignerHost));
    if (host != null)
    {
        ITemplate template = myControl.View1;
        if (region.Name == "Content1")
            template = myControl.View2;

        // Persist the template in the design host 
        if (template != null)
            return ControlPersister.PersistTemplate(template, host);
    }

    return String.Empty;
}
Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0
.NET Framework Security
Platforms

Windows Phone 8.1, Windows Phone 8, 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.