PageAdapter.RenderBeginHyperlink Method (HtmlTextWriter, String, Boolean, String)

Renders an opening hyperlink tag that includes the target URL to the response stream.

Namespace: System.Web.UI.Adapters
Assembly: System.Web (in system.web.dll)

public:
virtual void RenderBeginHyperlink (
	HtmlTextWriter^ writer, 
	String^ targetUrl, 
	bool encodeUrl, 
	String^ softkeyLabel
)
public void RenderBeginHyperlink (
	HtmlTextWriter writer, 
	String targetUrl, 
	boolean encodeUrl, 
	String softkeyLabel
)
public function RenderBeginHyperlink (
	writer : HtmlTextWriter, 
	targetUrl : String, 
	encodeUrl : boolean, 
	softkeyLabel : String
)
Not applicable.

Parameters

writer

The HtmlTextWriter containing methods to render the target-specific output.

targetUrl

The String value holding the target URL of the link.

encodeUrl

true to use HtmlAttributeEncode to encode the stream output; otherwise, false.

softkeyLabel

The String value to use as a soft key label.

The RenderBeginHyperlink method writes an opening hyperlink tag. When writer is HtmlTextWriter, this tag has the following format:

<a href=" targetUrl ">

Notes to Inheritors: When you inherit from the PageAdapter class, you can override the RenderBeginHyperlink method to write a different format for an opening hyperlink tag or to write additional tag attributes. For example, the RenderBeginHyperlink base method does not write an attribute for softkeyLabel.

The following code example demonstrates how to derive a class named CustomPageAdapter from the PageAdapter class and override the RenderBeginHyperlink method. The RenderBeginHyperlink method adds an attribute named src to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which CustomPageAdapter is attached will have the src attribute.

No code example is currently available or this language may not be supported.
import System.*;
import System.IO.*;
import System.Web.*;
import System.Web.UI.*;
import System.Web.UI.Adapters.*;

// A derived PageAdapter class.
public class CustomPageAdapter extends PageAdapter
{
	// Override RenderBeginHyperlink to add an attribute that 
	// references the referring page.
	public void RenderBeginHyperlink(HtmlTextWriter writer, String targetUrl,
		boolean encodeUrl, String softkeyLabel, String accessKey)
	{
		String url = null;

		// Add the src attribute, if referring page URL is available.
		if (this.get_Page() != null && this.get_Page().get_Request() != null 
			&& this.get_Page().get_Request().get_Url() != null) {
			url = this.get_Page().get_Request().get_Url().get_AbsoluteUri();
			if (encodeUrl) {
				url = HttpUtility.HtmlAttributeEncode(url);
			}
			writer.AddAttribute("src", url);
		}
		// Add the accessKey attribute, if caller requested.
		if (accessKey != null && accessKey.length() == 1) {
			writer.AddAttribute("accessKey", accessKey);
		}
		// Add the href attribute, encode the URL if requested.
		if (encodeUrl) {
			url = HttpUtility.HtmlAttributeEncode(targetUrl);
		}
		else {
			url = targetUrl;
		}
		writer.AddAttribute("href", url);

		// Render the hyperlink opening tag with the added attributes.
		writer.RenderBeginTag("a");
	} //RenderBeginHyperlink
} //CustomPageAdapter

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: