Sitecore 5.1.1 API

State.Desktop Property

Gets or sets the path of the client desktop webpage.

[Visual Basic]
Public Shared Property Desktop As String
[C#]
public static string Desktop {get; set;}

Property Value

The path to the webpage that specifies the Sitecore client.

Remarks

A desktop is the basic webpage that contains a Sitecore client. Sitecore only provides one desktop, but customers or partners may implement other desktops.

The desktop is initialized during user login. When the login procedure has completed, the browser is redirected to the desktop webpage.

The desktop for a specific user is specified in the Desktop field on the __User template. This is a lookup field pointing to "/sitecore/system/Desktops and Themes/Desktops".

If the user item does not specify a desktop, the value from DefaultDesktop is used.

The scope of the value is session and it is stored in the Session variable "SC_DESKTOP".

See Also

State Class | Sitecore.Configuration Namespace | Theme