LinkButton.RenderContents(HtmlTextWriter) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Renders the contents of the control to the specified writer.

protected:
 override void RenderContents(System::Web::UI::HtmlTextWriter ^ writer);

protected public:
 override void RenderContents(System::Web::UI::HtmlTextWriter ^ writer);

protected override void RenderContents(System.Web.UI.HtmlTextWriter writer);

protected internal override void RenderContents(System.Web.UI.HtmlTextWriter writer);

override this.RenderContents : System.Web.UI.HtmlTextWriter -> unit

Protected Overrides Sub RenderContents (writer As HtmlTextWriter)

Protected Friend Overrides Sub RenderContents (writer As HtmlTextWriter)

Parameters

writer: HtmlTextWriter

A HtmlTextWriter that represents the output stream to render HTML content on the client.

Examples

The following code example demonstrates how to override the RenderContents method in a custom server control so that some text is appended to the LinkButton.

ASP.NET (C#)

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS.Controls" Assembly="Samples.AspNet.CS" %>
<%@ Page Language="C#" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
        <title>Custom LinkButton - RenderContents - C# Example</title>
    <script runat="server">
      void LinkButton1_Command(Object sender, CommandEventArgs e) 
      {
        // Redirect to the Microsoft home page.
        Response.Redirect("http://www.microsoft.com/");
      }
    </script>
    </head>
    <body>
        <form id="Form1" method="post" runat="server">
            <h3>Custom LinkButton - RenderContents - C# Example</h3>
            
            <aspSample:CustomLinkButtonRenderContents 
              id="LinkButton1" 
              runat="server" 
              OnCommand="LinkButton1_Command" 
              ToolTip="Microsoft Home">Microsoft Corp.
            </aspSample:CustomLinkButtonRenderContents>

        </form>
    </body>
</html>

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB.Controls" Assembly="Samples.AspNet.VB" %>
<%@ Page Language="VB" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
        <title>Custom LinkButton - RenderContents - VB.NET Example</title>
        <script runat="server">
            Sub LinkButton1_Command(sender As Object, e As CommandEventArgs)
                ' Redirect to the Microsoft home page.
                Response.Redirect("http://www.microsoft.com/")
            End Sub
        </script>
    </head>
    <body>
        <form id="Form1" method="post" runat="server">
            <h3>Custom LinkButton - RenderContents - VB.NET Example</h3>
            
            <aspSample:CustomLinkButtonRenderContents id="LinkButton1" 
             runat="server" OnCommand="LinkButton1_Command" 
             ToolTip="Microsoft Home">Microsoft Corp.</aspSample:CustomLinkButtonRenderContents>

        </form>
    </body>
</html>

using System.Web;
using System.Security.Permissions;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)]
  public sealed class CustomLinkButtonRenderContents : System.Web.UI.WebControls.LinkButton
  {
    protected override void RenderContents(System.Web.UI.HtmlTextWriter writer)
    {
      // Call the base RenderContents method.
      base.RenderContents(writer);

      // Append some text to the LinkButton.
      writer.Write(" Home Page");
    }
  }
}

<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class CustomLinkButtonRenderContents
    Inherits System.Web.UI.WebControls.LinkButton

    Protected Overrides Sub RenderContents(ByVal writer As System.Web.UI.HtmlTextWriter)

        ' Call the base RenderContents method.
        MyBase.RenderContents(writer)

        ' Append some text to the LinkButton.
        writer.Write(" Home Page")
    End Sub
End Class

Remarks

This method is used primarily by control developers.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via