ControlDesigner.GetDesignTimeHtml Method

Definition

Recupera il markup HTML usato per rappresentare il controllo in fase di progettazione.Retrieves the HTML markup that is used to represent the control at design time.

Overloads

GetDesignTimeHtml(DesignerRegionCollection)

Recupera il markup HTML per la visualizzazione del controllo e popola la raccolta con le aree della finestra di progettazione controlli correnti.Retrieves the HTML markup to display the control and populates the collection with the current control designer regions.

GetDesignTimeHtml()

Recupera il markup HTML usato per rappresentare il controllo in fase di progettazione.Retrieves the HTML markup that is used to represent the control at design time.

GetDesignTimeHtml(DesignerRegionCollection)

Recupera il markup HTML per la visualizzazione del controllo e popola la raccolta con le aree della finestra di progettazione controlli correnti.Retrieves the HTML markup to display the control and populates the collection with the current control designer regions.

public:
 virtual System::String ^ GetDesignTimeHtml(System::Web::UI::Design::DesignerRegionCollection ^ regions);
public virtual string GetDesignTimeHtml (System.Web.UI.Design.DesignerRegionCollection regions);
abstract member GetDesignTimeHtml : System.Web.UI.Design.DesignerRegionCollection -> string
override this.GetDesignTimeHtml : System.Web.UI.Design.DesignerRegionCollection -> string
Public Overridable Function GetDesignTimeHtml (regions As DesignerRegionCollection) As String

Parameters

regions
DesignerRegionCollection

Raccolta di aree della finestra di progettazione controlli per il controllo associato.A collection of control designer regions for the associated control.

Returns

String

Markup HTML della fase di progettazione per il controllo associato, comprese tutte le aree della finestra di progettazione controlli.The design-time HTML markup for the associated control, including all control designer regions.

Examples

Nell'esempio di codice seguente viene illustrato come creare markup HTML utilizzando la raccolta di DesignerRegionCollection.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

Remarks

L'host di progettazione chiama il metodo GetDesignTimeHtml per ottenere il markup HTML della fase di progettazione e l'elenco corrente delle aree della finestra di progettazione del controllo.The design host calls the GetDesignTimeHtml method to get the design-time HTML markup and the current list of control designer regions. Utilizzando l'oggetto DesignerRegionCollection, l'host di progettazione può quindi richiedere il markup per ogni area della finestra di progettazione di controlli modificabile.Using the DesignerRegionCollection, the design host can then request the markup for each editable control designer region.

Il metodo GetDesignTimeHtml viene fornito per una finestra di progettazione di controlli derivata, ad esempio la classe GridViewDesigner, che deve elaborare il contenuto per l'area prima di chiamare il metodo GetDesignTimeHtml.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.

See also

GetDesignTimeHtml()

Recupera il markup HTML usato per rappresentare il controllo in fase di progettazione.Retrieves the HTML markup that is used to represent the control at design time.

public:
 virtual System::String ^ GetDesignTimeHtml();
public virtual string GetDesignTimeHtml ();
abstract member GetDesignTimeHtml : unit -> string
override this.GetDesignTimeHtml : unit -> string
Public Overridable Function GetDesignTimeHtml () As String

Returns

String

Markup HTML usato per rappresentare il controllo in fase di progettazione.The HTML markup used to represent the control at design time.

Examples

Nell'esempio di codice riportato di seguito viene illustrato come eseguire l'override del metodo GetDesignTimeHtml in una finestra di progettazione controlli personalizzata.The following code example demonstrates how to override the GetDesignTimeHtml method in a custom control designer. Se la proprietà Text per il controllo associato è vuota, il metodo GetDesignTimeHtml chiama il metodo GetEmptyDesignTimeHtml.If the Text property for the associated control is empty, the GetDesignTimeHtml method calls the GetEmptyDesignTimeHtml method. In caso contrario, il metodo GetDesignTimeHtml crea ed esegue il rendering di un controllo collegamento ipertestuale.Otherwise, the GetDesignTimeHtml method creates and renders a Hyperlink control.

public override string GetDesignTimeHtml()
{
    if (simpleControl.Text.Length > 0)
    {
        string spec = "<a href='{0}.aspx'>{0}</a>";
        return String.Format(spec, simpleControl.Text);
    }
    else
    {
        return GetEmptyDesignTimeHtml();
    }
}
Public Overrides Function GetDesignTimeHtml() As String
   ' Component is the instance of the component or control that
   ' this designer object is associated with. This property is 
   ' inherited from System.ComponentModel.ComponentDesigner.
   simpleControl = CType(Component, Simple)
   
   If simpleControl.Text.Length > 0 Then
      Dim sw As New StringWriter()
      Dim tw As New HtmlTextWriter(sw)
      
      Dim placeholderLink As New HyperLink()
      
      ' Put simpleControl.Text into the link's Text.
      placeholderLink.Text = simpleControl.Text
      placeholderLink.NavigateUrl = simpleControl.Text
      placeholderLink.RenderControl(tw)
      
      Return sw.ToString()
   Else
      Return GetEmptyDesignTimeHtml()
   End If
End Function

Notes to Inheritors

Se si crea un controllo contenitore personalizzato, assicurarsi di eseguire il rendering del controllo e di tutti i controlli figlio in fase di progettazione, indipendentemente dal fatto che la proprietà Visible sia impostata su true o false.If you are creating a custom container control, make sure that you render the control and all child controls at design time, regardless of whether the Visible property is set to true or false.

See also

Applies to