Export (0) Print
Expand All

ControlDesigner.GetEditableDesignerRegionContent Method

Note: This method is new in the .NET Framework version 2.0.

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)

public virtual string GetEditableDesignerRegionContent (
	EditableDesignerRegion region
)
public String GetEditableDesignerRegionContent (
	EditableDesignerRegion region
)
public function GetEditableDesignerRegionContent (
	region : EditableDesignerRegion
) : String

Parameters

region

The EditableDesignerRegion to get content for.

Return Value

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

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.

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

  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show:
© 2014 Microsoft