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.

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.UINonVisualControlAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class NonVisualControlAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class NonVisualControlAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type NonVisualControlAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class)>
Public NotInheritable Class NonVisualControlAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod NonVisualControlAttribute

Initializes a new instance of the NonVisualControlAttribute class.

System_CAPS_pubmethod NonVisualControlAttribute

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.

Properties
NameDescription
System_CAPS_pubproperty

Gets a value indicating whether the control is non-visual.

System_CAPS_pubproperty

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

Methods
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

Returns the hash code for this instance.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

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

System_CAPS_pubmethod IsDefaultAttribute

Returns a value indicating whether the current instance is equivalent to a default instance of the NonVisualControlAttribute class.(Overrides AttributeIsDefaultAttribute.)

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.)

Fields
NameDescription
System_CAPS_pubfield System_CAPS_static Default

Returns a NonVisualControlAttribute instance that represents the application-defined default value of the attribute. This field is read-only.

System_CAPS_pubfield System_CAPS_static 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.

System_CAPS_pubfield System_CAPS_static Visual

Gets a NonVisualControlAttribute instance that is applied to a Web control to be treated as a visual control during design time.

Explicit Interface Implementations
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.)

Remarks

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.

Examples

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.
}
<NonVisualControlAttribute()> _
Public Class CustomNonVisualControl
    Inherits Control

    ' Add an implementation of custom non-visual control.

End Class
Version Information
.NET Framework
Available since 2.0
Thread Safety

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