This documentation is archived and is not being maintained.

UrlPropertyAttribute Class

Defines the attribute that controls use to identify string properties containing URL values. This class cannot be inherited.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class UrlPropertyAttribute _
	Inherits Attribute
'Usage
Dim instance As UrlPropertyAttribute

The UrlPropertyAttribute attribute is an attribute applied to a control property that represents a URL. In addition to marking a string property as representing a URL, the UrlPropertyAttribute attribute defines the Filter property that identifies specific file types that can be used to filter against the property.

The following code example demonstrates a class that implements a URL-specific property. In this code example, a UrlPropertyAttribute attribute is applied to the TargetUrl property of the CustomHyperLinkControl class. The attribute sets a specific file filter for ASP.NET files.

Public Class CustomHyperLinkControl
    Inherits WebControl

    Public Sub New()
    End Sub 'New 

    ' The TargetUrl property represents the URL that  
    ' the custom hyperlink control navigates to.        
    <UrlProperty("*.aspx")> _
    Public Property TargetUrl() As String 
        Get 
            Dim s As String = CStr(ViewState("TargetUrl"))
            If (s Is Nothing) Then 
                Return String.Empty
            Else 
                Return s
            End If 
        End Get 
        Set(ByVal value As String)
            ViewState("TargetUrl") = value
        End Set 
    End Property 

    ' The Text property represents the visible text that  
    ' the custom hyperlink control is displayed with.                 
    Public Overridable Property [Text]() As String 
        Get 
            Dim s As String = CStr(ViewState("Text"))
            If (s Is Nothing) Then 
                Return String.Empty
            Else 
                Return s
            End If 
        End Get 
        Set(ByVal value As String)
            ViewState("Text") = value
        End Set 
    End Property 

    ' Implement method to render the control. 

End Class 'CustomHyperLinkControl

System.Object
  System.Attribute
    System.Web.UI.UrlPropertyAttribute

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: