ViewUserControl Class

Represents the information that is needed to build a user control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        System.Web.Mvc.ViewUserControl
          System.Web.Mvc.ViewUserControl<TModel>

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

Syntax

'Declaration
Public Class ViewUserControl _
    Inherits UserControl _
    Implements IViewDataContainer

public class ViewUserControl : UserControl, 
    IViewDataContainer

public ref class ViewUserControl : public UserControl, 
    IViewDataContainer

The ViewUserControl type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Adapter	Gets the browser-specific adapter for the control. (Inherited from Control.)
	Ajax	Gets the AJAX script for the view.
	Application	Gets the Application object for the current Web request. (Inherited from UserControl.)
	AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
	AppRelativeVirtualPath	Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled. (Inherited from TemplateControl.)
	Attributes	Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file. (Inherited from UserControl.)
	AutoHandlers	Infrastructure. Obsolete. The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code. (Inherited from TemplateControl.)
	BindingContainer	Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
	Cache	Gets the Cache object that is associated with the application that contains the user control. (Inherited from UserControl.)
	CachePolicy	Gets a reference to a collection of caching parameters for this user control. (Inherited from UserControl.)
	ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
	ClientID	Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
	ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
	Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
	Controls	Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
	DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
	EnableTheming	Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class. (Inherited from TemplateControl.)
	EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
	Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
	HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
	Html	Gets the HTML for the view.
	ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
	IdSeparator	Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
	IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
	IsPostBack	Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time. (Inherited from UserControl.)
	IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
	IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control.)
	LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
	Model	Gets the model.
	NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.)
	Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control.)
	Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
	Request	Gets the HttpRequest object for the current Web request. (Inherited from UserControl.)
	Response	Gets the HttpResponse object for the current Web request. (Inherited from UserControl.)
	Server	Gets the HttpServerUtility object for the current Web request. (Inherited from UserControl.)
	Session	Gets the HttpSessionState object for the current Web request. (Inherited from UserControl.)
	Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
	SkinID	Gets or sets the skin to apply to the control. (Inherited from Control.)
	SupportAutoEvents	Infrastructure. Gets a value indicating whether the TemplateControl control supports automatic events. (Inherited from TemplateControl.)
	TempData	Gets the temporary-data dictionary.
	TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control.)
	TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
	Trace	Gets the TraceContext object for the current Web request. (Inherited from UserControl.)
	UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
	Url	Gets the URL for the view.
	ViewContext	Gets or sets the view context.
	ViewData	Gets or sets the view-data dictionary.
	ViewDataKey	Gets or sets the view-data key.
	ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.)
	ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
	Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
	Writer	Gets the writer that is used to render the view to the response.

Top

Methods

	Name	Description
	AddedControl	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
	AddParsedSubObject	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
	ApplyStyleSheetSkin	Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
	BuildProfileTree	Infrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.)
	ClearChildControlState	Deletes the control-state information for the server control's child controls. (Inherited from Control.)
	ClearChildState	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
	ClearChildViewState	Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
	Construct	Performs design-time logic. (Inherited from TemplateControl.)
	CreateChildControls	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.)
	CreateControlCollection	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
	CreateResourceBasedLiteralControl	Infrastructure. Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl method is not intended for use from within your code. (Inherited from TemplateControl.)
	DataBind()	Binds a data source to the invoked server control and all its child controls. (Inherited from Control.)
	DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
	DataBindChildren	Binds a data source to the server control's child controls. (Inherited from Control.)
	DesignerInitialize	Performs any initialization steps on the user control that are required by RAD designers. (Inherited from UserControl.)
	Dispose	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
	EnsureChildControls	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
	EnsureID	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
	EnsureViewData	Ensures that view data is added to the ViewDataDictionary object of the user control if the view data exists.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Eval(String)	Evaluates a data-binding expression. (Inherited from TemplateControl.)
	Eval(String, String)	Evaluates a data-binding expression using the specified format string to display the result. (Inherited from TemplateControl.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindControl(String)	Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
	FindControl(String, Int32)	Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.)
	Focus	Sets input focus to a control. (Inherited from Control.)
	FrameworkInitialize	Infrastructure. Initializes the control that is derived from the TemplateControl class. (Inherited from TemplateControl.)
	GetDesignModeState	Infrastructure. Gets design-time data for a control. (Inherited from Control.)
	GetGlobalResourceObject(String, String)	Gets an application-level resource object based on the specified ClassKey and ResourceKey properties. (Inherited from TemplateControl.)
	GetGlobalResourceObject(String, String, Type, String)	Gets an application-level resource object based on the specified ClassKey and ResourceKey properties, object type, and property name of the resource. (Inherited from TemplateControl.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLocalResourceObject(String)	Gets a page-level resource object based on the specified ResourceKey property. (Inherited from TemplateControl.)
	GetLocalResourceObject(String, Type, String)	Gets a page-level resource object based on the specified ResourceKey property, object type, and property name. (Inherited from TemplateControl.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasControls	Determines if the server control contains any child controls. (Inherited from Control.)
	HasEvents	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
	InitializeAsUserControl	Initializes the UserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly. (Inherited from UserControl.)
	IsLiteralContent	Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
	LoadControl(String)	Loads a Control object from a file based on a specified virtual path. (Inherited from TemplateControl.)
	LoadControl(Type, Object[])	Loads a Control object based on a specified type and constructor parameters. (Inherited from TemplateControl.)
	LoadControlState	Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
	LoadTemplate	Obtains an instance of the ITemplate interface from an external file. (Inherited from TemplateControl.)
	LoadViewState	Restores the view-state information from a previous user control request that was saved by the SaveViewState method. (Inherited from UserControl.)
	MapPath	Assigns a virtual file path, either absolute or relative, to a physical file path. (Inherited from UserControl.)
	MapPathSecure	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAbortTransaction	Raises the AbortTransaction event. (Inherited from TemplateControl.)
	OnBubbleEvent	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
	OnCommitTransaction	Raises the CommitTransaction event. (Inherited from TemplateControl.)
	OnDataBinding	Raises the DataBinding event. (Inherited from Control.)
	OnError	Raises the Error event. (Inherited from TemplateControl.)
	OnInit	Raises the Init event. (Inherited from UserControl.)
	OnLoad	Raises the Load event. (Inherited from Control.)
	OnPreRender	Raises the PreRender event. (Inherited from Control.)
	OnUnload	Raises the Unload event. (Inherited from Control.)
	OpenFile	Gets a Stream used to read a file. (Inherited from Control.)
	ParseControl(String)	Parses an input string into a Control object on the Web Forms page or user control. (Inherited from TemplateControl.)
	ParseControl(String, Boolean)	Parses an input string into a Control object on the ASP.NET Web page or user control. (Inherited from TemplateControl.)
	RaiseBubbleEvent	Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
	ReadStringResource	Infrastructure. Reads a string resource. The ReadStringResource method is not intended for use from within your code. (Inherited from TemplateControl.)
	RemovedControl	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
	Render	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
	RenderChildren	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
	RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
	RenderView	Renders the view by using the specified view context.
	ResolveAdapter	Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
	ResolveClientUrl	Gets a URL that can be used by the browser. (Inherited from Control.)
	ResolveUrl	Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
	SaveControlState	Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
	SaveViewState	Saves any user control view-state changes that have occurred since the last page postback. (Inherited from UserControl.)
	SetDesignModeState	Sets design-time data for a control. (Inherited from Control.)
	SetRenderMethodDelegate	Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
	SetStringResourcePointer	Infrastructure. Sets a pointer to a string resource. The SetStringResourcePointer method is used by generated classes and is not intended for use from within your code. (Inherited from TemplateControl.)
	SetTextWriter	Obsolete. Sets the text writer that is used to render the view to the response.
	SetViewData	Sets the view-data dictionary by using the specified view data.
	TestDeviceFilter	Returns a Boolean value indicating whether a device filter applies to the HTTP request. (Inherited from TemplateControl.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrackViewState	Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the Control.ViewState property. (Inherited from Control.)
	WriteUTF8ResourceString	Infrastructure. Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString method is used by generated classes and is not intended for use from within your code. (Inherited from TemplateControl.)
	XPath(String)	Evaluates an XPath data-binding expression. (Inherited from TemplateControl.)
	XPath(String, IXmlNamespaceResolver)	Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution. (Inherited from TemplateControl.)
	XPath(String, String)	Evaluates an XPath data-binding expression using the specified format string to display the result. (Inherited from TemplateControl.)
	XPath(String, String, IXmlNamespaceResolver)	Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result. (Inherited from TemplateControl.)
	XPathSelect(String)	Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface. (Inherited from TemplateControl.)
	XPathSelect(String, IXmlNamespaceResolver)	Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the IEnumerable interface. (Inherited from TemplateControl.)

Top

Events

	Name	Description
	AbortTransaction	Occurs when a user ends a transaction. (Inherited from TemplateControl.)
	CommitTransaction	Occurs when a transaction completes. (Inherited from TemplateControl.)
	DataBinding	Occurs when the server control binds to a data source. (Inherited from Control.)
	Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
	Error	Occurs when an unhandled exception is thrown. (Inherited from TemplateControl.)
	Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
	Load	Occurs when the server control is loaded into the Page object. (Inherited from Control.)
	PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
	Unload	Occurs when the server control is unloaded from memory. (Inherited from Control.)

Top

Explicit Interface Implementations

	Name	Description
	IParserAccessor.AddParsedSubObject	For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
	IFilterResolutionService.CompareFilters	Infrastructure. Returns a value that indicates whether a parent/child relationship exists between two specified device filters. (Inherited from TemplateControl.)
	IControlBuilderAccessor.ControlBuilder	For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
	IDataBindingsAccessor.DataBindings	For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
	IFilterResolutionService.EvaluateFilter	Infrastructure. Returns a value that indicates whether the specified filter is a type of the current filter object. (Inherited from TemplateControl.)
	IExpressionsAccessor.Expressions	For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
	IAttributeAccessor.GetAttribute	Infrastructure. Returns the value of the specified user control attribute. (Inherited from UserControl.)
	IControlDesignerAccessor.GetDesignModeState	For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
	IDataBindingsAccessor.HasDataBindings	For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
	IExpressionsAccessor.HasExpressions	For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
	IUserControlDesignerAccessor.InnerText	Infrastructure. Gets or sets the text that appears between the opening and closing tags of a user control. (Inherited from UserControl.)
	IAttributeAccessor.SetAttribute	Infrastructure. Sets the value of the specified user control attribute. (Inherited from UserControl.)
	IControlDesignerAccessor.SetDesignModeState	For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl	Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
	IUserControlDesignerAccessor.TagName	Gets or sets the full tag name of the user control. (Inherited from UserControl.)
	IControlDesignerAccessor.UserData	For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)

Top

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.

See Also

Reference

System.Web.Mvc Namespace