ChildActionOnlyAttribute Class

Article
02/21/2011

Represents an attribute that is used to indicate that an action method should be called only as a child action.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Web.Mvc.FilterAttribute
      System.Web.Mvc.ChildActionOnlyAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple := False,  _
    Inherited := True)> _
Public NotInheritable Class ChildActionOnlyAttribute _
    Inherits FilterAttribute _
    Implements IAuthorizationFilter

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false, 
    Inherited = true)]
public sealed class ChildActionOnlyAttribute : FilterAttribute, 
    IAuthorizationFilter

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, AllowMultiple = false, 
    Inherited = true)]
public ref class ChildActionOnlyAttribute sealed : public FilterAttribute, 
    IAuthorizationFilter

The ChildActionOnlyAttribute type exposes the following members.

Constructors

	Name	Description
	ChildActionOnlyAttribute	Initializes a new instance of the ChildActionOnlyAttribute class.

Top

Properties

	Name	Description
	Order	Gets or sets the order in which the action filters are executed. (Inherited from FilterAttribute.)
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAuthorization	Called when authorization is required.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

A child action method renders inline HTML markup for part of a view instead of rendering a whole view.

Any method that is marked with ChildActionOnlyAttribute can be called only with the Action or RenderAction HTML extension methods.

For more information about using attributes, see Extending Metadata Using Attributes.

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.