ControlDesigner.GetEditableDesignerRegionContent Method (System.Web.UI.Design)

Welcome Sign in

Developer Centers

MSDN Home

Microsoft Developer Network

.NET Framework Class Library

ControlDesigner..::.GetEditableDesignerRegionContent Method

Updated: November 2007

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

Visual Basic (Declaration)

Public Overridable Function GetEditableDesignerRegionContent ( _
    region As EditableDesignerRegion _
) As String

Visual Basic (Usage)

Dim instance As ControlDesigner
Dim region As EditableDesignerRegion
Dim returnValue As String

returnValue = instance.GetEditableDesignerRegionContent(region)

public virtual string GetEditableDesignerRegionContent(
    EditableDesignerRegion region
)

Visual C++

public:
virtual String^ GetEditableDesignerRegionContent(
    EditableDesignerRegion^ region
)

public String GetEditableDesignerRegionContent(
    EditableDesignerRegion region
)

JScript

public function GetEditableDesignerRegionContent(
    region : EditableDesignerRegion
) : String

Parameters

region: Type: System.Web.UI.Design..::.EditableDesignerRegion
The EditableDesignerRegion object to get content for.

Return Value

Type: System..::.String

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.

Visual Basic

' 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;
}

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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.

Version Information