View Source

Class SurfaceController

Provides a base class for front-end add-in controllers.

Inheritance

System.Object

PluginController

Namespace: Umbraco.Web.Mvc

Assembly: Umbraco.Web.dll

Syntax

public abstract class SurfaceController : PluginController, IDiscoverable

Constructors

SurfaceController()

Declaration

protected SurfaceController()

SurfaceController(IUmbracoContextAccessor, IUmbracoDatabaseFactory, ServiceContext, AppCaches, ILogger, IProfilingLogger, UmbracoHelper)

Declaration

protected SurfaceController(IUmbracoContextAccessor umbracoContextAccessor, IUmbracoDatabaseFactory databaseFactory, ServiceContext services, AppCaches appCaches, ILogger logger, IProfilingLogger profilingLogger, UmbracoHelper umbracoHelper)

Parameters

Type	Name	Description
IUmbracoContextAccessor	umbracoContextAccessor
IUmbracoDatabaseFactory	databaseFactory
ServiceContext	services
AppCaches	appCaches
ILogger	logger
IProfilingLogger	profilingLogger
UmbracoHelper	umbracoHelper

Properties

CurrentPage

Gets the current page.

Declaration

protected virtual IPublishedContent CurrentPage { get; }

Property Value

Type	Description
IPublishedContent

Methods

CurrentUmbracoPage()

Returns the currently rendered Umbraco page

Declaration

protected UmbracoPageResult CurrentUmbracoPage()

Returns

Type	Description
UmbracoPageResult

RedirectToCurrentUmbracoPage()

Redirects to the currently rendered Umbraco page

Declaration

protected RedirectToUmbracoPageResult RedirectToCurrentUmbracoPage()

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToCurrentUmbracoPage(NameValueCollection)

Redirects to the currently rendered Umbraco page and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToCurrentUmbracoPage(NameValueCollection queryStringValues)

Parameters

Type	Name	Description
System.Collections.Specialized.NameValueCollection	queryStringValues

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToCurrentUmbracoPage(String)

Redirects to the currently rendered Umbraco page and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToCurrentUmbracoPage(string queryString)

Parameters

Type	Name	Description
System.String	queryString

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToCurrentUmbracoUrl()

Redirects to the currently rendered Umbraco URL

Declaration

protected RedirectToUmbracoUrlResult RedirectToCurrentUmbracoUrl()

Returns

Type	Description
RedirectToUmbracoUrlResult

Remarks

this is useful if you need to redirect to the current page but the current page is actually a rewritten URL normally done with something like Server.Transfer.

RedirectToUmbracoPage(Guid)

Redirects to the Umbraco page with the given id

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(Guid key)

Parameters

Type	Name	Description
System.Guid	key

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(Guid, NameValueCollection)

Redirects to the Umbraco page with the given id and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(Guid key, NameValueCollection queryStringValues)

Parameters

Type	Name	Description
System.Guid	key
System.Collections.Specialized.NameValueCollection	queryStringValues

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(Guid, String)

Redirects to the Umbraco page with the given id and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(Guid key, string queryString)

Parameters

Type	Name	Description
System.Guid	key
System.String	queryString

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(Int32)

Redirects to the Umbraco page with the given id

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(int pageId)

Parameters

Type	Name	Description
System.Int32	pageId

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(Int32, NameValueCollection)

Redirects to the Umbraco page with the given id and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(int pageId, NameValueCollection queryStringValues)

Parameters

Type	Name	Description
System.Int32	pageId
System.Collections.Specialized.NameValueCollection	queryStringValues

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(Int32, String)

Redirects to the Umbraco page with the given id and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(int pageId, string queryString)

Parameters

Type	Name	Description
System.Int32	pageId
System.String	queryString

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(IPublishedContent)

Redirects to the Umbraco page with the given id

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(IPublishedContent publishedContent)

Parameters

Type	Name	Description
IPublishedContent	publishedContent

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(IPublishedContent, NameValueCollection)

Redirects to the Umbraco page with the given id and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(IPublishedContent publishedContent, NameValueCollection queryStringValues)

Parameters

Type	Name	Description
IPublishedContent	publishedContent
System.Collections.Specialized.NameValueCollection	queryStringValues

Returns

Type	Description
RedirectToUmbracoPageResult

RedirectToUmbracoPage(IPublishedContent, String)

Redirects to the Umbraco page with the given id and passes provided querystring

Declaration

protected RedirectToUmbracoPageResult RedirectToUmbracoPage(IPublishedContent publishedContent, string queryString)

Parameters

Type	Name	Description
IPublishedContent	publishedContent
System.String	queryString

Returns

Type	Description
RedirectToUmbracoPageResult