Image.RenderContents(HtmlTextWriter) Method

Definition

Renders the image control contents to the specified writer.

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

Parameters

writer
HtmlTextWriter

An 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 always displayed after the Image.

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 Image - RenderContents - C# Example</title>
    </head>
    <body>
        <form id="Form1" method="post" runat="server">
            <h3>Custom Image - RenderContents - C# Example</h3>
            
            <aspSample:CustomImageRenderContents 
              id="Image1" 
              runat="server" 
              ImageUrl="http://www.microsoft.com/homepage/gif/bnr-microsoft.gif" 
              AlternateText="Microsoft Home" />
            
        </form>
    </body>
</html>
C#
using System.Web;
using System.Security.Permissions;

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

      // Append some text to the Image.
      writer.Write("<BR>Experience Windows Server 2003 and Visual Studio® .NET 2003.");
    }
  }
}

Remarks

The RenderContents method is primarily used by control developers. The Image control implements the RenderContents method to skip rendering of any child controls.

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

See also