Export (0) Print
Expand All

UrlPropertyAttribute Class

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

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

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

[AttributeUsageAttribute(AttributeTargets.Property)]
public sealed class UrlPropertyAttribute : Attribute

The UrlPropertyAttribute type exposes the following members.

  NameDescription
Public methodUrlPropertyAttribute()Initializes a new default instance of the UrlPropertyAttribute class.
Public methodUrlPropertyAttribute(String)Initializes a new instance of the UrlPropertyAttribute class, setting the Filter property to the specified string.
Top

  NameDescription
Public propertyFilterGets a file filter associated with the URL-specific property.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsReturns a value that indicates whether this instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
Public methodGetHashCodeReturns the hash code for this instance. (Overrides Attribute.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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 : WebControl
{
    public CustomHyperLinkControl() { }

    // The TargetUrl property represents the URL that  
    // the custom hyperlink control navigates to.
    [UrlProperty("*.aspx")]
    public string TargetUrl
    {
        get
        {
            string s = (string)ViewState["TargetUrl"];
            return ((s == null) ? String.Empty : s);
        }
        set
        {
            ViewState["TargetUrl"] = value;
        }
    }

    // The Text property represents the visible text that  
    // the custom hyperlink control is displayed with.         
    public virtual string Text
    {
        get
        {
            string s = (string)ViewState["Text"];
            return ((s == null) ? String.Empty : s);
        }
        set
        {
            ViewState["Text"] = value;
        }
    }

    // Implement method to render the control.
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

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