ViewResult Class

Visual Studio 2010

Represents a class that is used to render a view by using an IView instance that is returned by an IViewEngine object.

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

public ref class ViewResult : public ViewResultBase

The ViewResult type exposes the following members.

Public methodViewResultInitializes a new instance of the ViewResult class.

Public propertyMasterNameGets the name of the master view (such as a master page or template) to use when the view is rendered.
Public propertyTempDataGets or sets the TempDataDictionary object for this result. (Inherited from ViewResultBase.)
Public propertyViewGets or sets the IView object that is rendered to the response. (Inherited from ViewResultBase.)
Public propertyViewDataGets or sets the view data ViewDataDictionary object for this result. (Inherited from ViewResultBase.)
Public propertyViewEngineCollectionGets or sets the collection of view engines that are associated with this result. (Inherited from ViewResultBase.)
Public propertyViewNameGets or sets the name of the view to render. (Inherited from ViewResultBase.)

Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExecuteResultWhen called by the action invoker, renders the view to the response. (Inherited from ViewResultBase.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodFindViewSearches the registered view engines and returns the object that is used to render the view. (Overrides ViewResultBase::FindView(ControllerContext).)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

An action result represents a command that ASP.NET performs on behalf of an action method. The ViewResult class implements the abstract ViewResultBase class and is used to render a view. This class contains methods for finding the view to render and for executing the result. This class also contains properties that identify the view to render, the name of the view, the name of the master view, view data, temporary data, and a collection for view engines for the application.

If you want an action method to result in a rendered view, the action method should return a call to the controller's View helper method. The View helper method passes a ViewResult object to the ASP.NET MVC framework, which calls the object's ExecuteResult method.

The following example shows an action method that uses the controller's View helper method to pass a ViewResult object to the framework, which then executes the result and renders the view.

No code example is currently available or this language may not be supported.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.