TagPrefixAttribute(String, String) Constructor

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Initializes a new instance of the TagPrefixAttribute class.

public:
 TagPrefixAttribute(System::String ^ namespaceName, System::String ^ tagPrefix);

public TagPrefixAttribute (string namespaceName, string tagPrefix);

new System.Web.UI.TagPrefixAttribute : string * string -> System.Web.UI.TagPrefixAttribute

Public Sub New (namespaceName As String, tagPrefix As String)

Parameters

namespaceName

String

A string that identifies the custom control namespace.

tagPrefix

String

A string that identifies the custom control prefix.

Exceptions

ArgumentException

The namespaceName or the tagPrefix is null or an empty string ("").

Examples

The following code example shows how to define an assembly-level attribute that enables you to specify a tag prefix alias for a custom control. This attribute is used by tools such as Microsoft Visual Studio to automatically generate a @ Register directive in Web pages where the custom controls are used.

using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

[assembly:TagPrefix("CustomControls", "custom")]

namespace CustomControls
{

    // Simple custom control
    public class MyCS_Control : Control
      {
            private String message = "Hello";
            
            public virtual String Message
            {
                  get
                  {
                        return message;
                  }
                  set
                  {
                        message = value;
                  }
            }
            
            [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] 
            protected override void Render( HtmlTextWriter writer)
            {
            writer.Write("<span style='background-color:aqua; font:8pt tahoma, verdana;'> "
                        + this.Message + "<br>" + "C# version. The time on the server is " + System.DateTime.Now.ToLongTimeString()
                        + "</span>");
            }
      }
}

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls

<assembly: TagPrefix("CustomControls", "custom")> _

Namespace CustomControls
   
   ' Simple custom control
   Public Class MyVB_Control 
   Inherits Control
      Private message As String = "Hello"
      
      Public  Property getMessage() As String
         Get
            Return message
         End Get
         Set (ByVal value As String)
            message = value
         End Set
      End Property
      
      <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
      Protected Overrides Sub Render(writer As HtmlTextWriter)
         writer.Write(("<span style='background-color:aqua; font:8pt tahoma, verdana;'> " + Me.getMessage + "<br>" + "VB version. The time on the server is " + System.DateTime.Now.ToLongTimeString() + "</span>"))
      End Sub
   End Class
End Namespace 'CustomControls

Remarks

In defining your custom control, and prior to any code, you should invoke this class constructor as follows:

[assembly:TagPrefix(namespace, tag)]