ThemeableAttribute Class
 

Defines the metadata attribute that Web server controls and their members use to indicate whether their rendering can be affected by themes and control skins. This class cannot be inherited.

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

SystemObject
   SystemAttribute
    System.Web.UIThemeableAttribute

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Property)]
public sealed class ThemeableAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Property)]
public ref class ThemeableAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Property)>]
type ThemeableAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Property)>
Public NotInheritable Class ThemeableAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod ThemeableAttribute

Initializes a new instance of the ThemeableAttribute class, using the specified Boolean value to determine whether the attribute represents a type or member that is affected by themes and control skins.

NameDescription
System_CAPS_pubproperty

Gets a value indicating whether the current control or member of a control can be affected by themes and control skins defined for the Web application.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethod Equals

Returns a value that indicates whether this instance is equal to a specified object.(Overrides AttributeEquals.)

System_CAPS_pubmethod GetHashCode

Serves as a hash function for the ThemeableAttribute type. (Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

Gets a value indicating whether the current instance is equivalent to a Default instance of the ThemeableAttribute class.(Overrides AttributeIsDefaultAttribute.)

System_CAPS_pubmethod System_CAPS_static IsObjectThemeable

Returns a value indicating whether the object passed to the method supports themes.

System_CAPS_pubmethod System_CAPS_static IsTypeThemeable

Returns a value indicating whether the Type passed to the method supports themes.

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfield System_CAPS_static Default

Gets a ThemeableAttribute instance that represents the application-defined default value of the attribute.

System_CAPS_pubfield System_CAPS_static No

Gets a ThemeableAttribute instance used to decorate a type or member that is not affected by themes and control skins.

System_CAPS_pubfield System_CAPS_static Yes

Gets a ThemeableAttribute instance used to decorate a type or member that is affected by themes and control skins.

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Control developers use the ThemeableAttribute attribute to decorate control types and their members, to signal which ones can and cannot be affected by themes and control skins. By default, all properties exposed by a control are themeable. However, themes are typically applied only to stylistic properties; the Themeable(false) attribute should be applied explicitly to all non-stylistic properties. Decorating a member with the Themeable(false) attribute ensures that the member is not themed, regardless of the value of the property. For example, if the ThemeableAttribute attribute is applied to a control and set to false, the control is not affected by themes even when its property is set to true.

The ThemeableAttribute class maintains a static list of all types that support themes, and this list is consulted whenever the static methods IsObjectThemeable and IsTypeThemeable are called.

The following code example demonstrates how you can apply the ThemeableAttribute attribute to a member of a control. In this example, ThemeableAttribute is applied to a data-bound control and false is passed to the ThemeableAttribute constructor, indicating that the DataSourceID member cannot have themes applied. (Passing false to the constructor results in a ThemeableAttribute instance that is equivalent to the No field.)

namespace Samples.AspNet.CS.Controls {
    using System;
    using System.Web.UI;
    using System.Web.UI.WebControls;


    public class SomeDataBoundControl : DataBoundControl
    {
        // Implementation of a custom data source control.

        [Themeable(false) ]
        [IDReferenceProperty()]
        public override string DataSourceID {
            get {
                return base.DataSourceID;
            }
            set {
                base.DataSourceID = value;
            }
        }

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

Public Class SomeDataBoundControl
    Inherits DataBoundControl

    ' Implementation of a custom data source control.

    <Themeable(False)> _
    <IDReferenceProperty()>  _
    Public Overrides Property DataSourceID() As String 
        Get
            Return MyBase.DataSourceID
        End Get
        Set
            MyBase.DataSourceID = value
        End Set
    End Property

End Class 'SomeDataBoundControl 
.NET Framework
Available since 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.

Return to top