This topic has not yet been rated - Rate this topic

NonVisualControlAttribute Class

Defines the attribute that indicates whether a control is treated as a visual or non-visual control during design time. This class cannot be inherited.

System.Object
  System.Attribute
    System.Web.UI.NonVisualControlAttribute

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class NonVisualControlAttribute : Attribute

The NonVisualControlAttribute type exposes the following members.

  Name Description
Public method NonVisualControlAttribute() Initializes a new instance of the NonVisualControlAttribute class.
Public method NonVisualControlAttribute(Boolean) Initializes a new instance of the NonVisualControlAttribute class, using the specified Boolean value to determine whether the attribute represents a visual or non-visual control.
Top
  Name Description
Public property IsNonVisual Gets a value indicating whether the control is non-visual.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Equals Returns a value that indicates whether this instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Overrides Attribute.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute Returns a value indicating whether the current instance is equivalent to a default instance of the NonVisualControlAttribute class. (Overrides Attribute.IsDefaultAttribute().)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public field Static member Default Returns a NonVisualControlAttribute instance that represents the application-defined default value of the attribute. This field is read-only.
Public field Static member NonVisual Returns a NonVisualControlAttribute instance that is applied to a Web control to be treated as a non-visual control during design time. This field is read-only.
Public field Static member Visual Gets a NonVisualControlAttribute instance that is applied to a Web control to be treated as a visual control during design time.
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The NonVisualControlAttribute attribute is applied to controls that are not rendered to the client, such as data source controls and the WebPartManager control. During design time, a page developer might decide to hide all non-visual controls. The designer would mark as invisible all of the controls with the NonVisualControlAttribute attribute set to true.

Examples of controls that employ the NonVisualControlAttribute attribute are DataSourceControl, HierarchicalDataSourceControl, HiddenField, and WebPartManager.

The following code example demonstrates how you can apply the NonVisualControlAttribute attribute to a class. In this example, the default NonVisualControlAttribute attribute is applied to a data source control. This is equivalent to the NonVisual field.


[NonVisualControlAttribute()]
public class CustomNonVisualControl : Control
{
    // Add an implementation of custom non-visual control.
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ