View Source

Class GlobalSettings

The GlobalSettings Class contains general settings information for the entire Umbraco instance based on information from web.config appsettings

Inheritance

System.Object

Namespace: Umbraco.Core.Configuration

Assembly: Umbraco.Core.dll

Syntax

public class GlobalSettings : IGlobalSettings

Properties

ConfigurationStatus

Gets or sets the configuration status. This will return the version number of the currently installed umbraco instance.

Declaration

public string ConfigurationStatus { get; set; }

Property Value

Type	Description
System.String	The configuration status.

ContentXmlFile

Gets the name of the content XML file.

Declaration

public string ContentXmlFile { get; }

Property Value

Type	Description
System.String	The content XML.

Remarks

Defaults to ~/App_Data/umbraco.config

DebugMode

Gets a value indicating whether umbraco is running in [debug mode].

Declaration

public static bool DebugMode { get; }

Property Value

Type	Description
System.Boolean	true if [debug mode]; otherwise, false.

DefaultUILanguage

Gets the default UI language.

Declaration

public string DefaultUILanguage { get; }

Property Value

Type	Description
System.String	The default UI language.

HideTopLevelNodeFromPath

Gets a value indicating whether umbraco should hide top level nodes from generated URLs.

Declaration

public bool HideTopLevelNodeFromPath { get; }

Property Value

Type	Description
System.Boolean	true if umbraco hides top level nodes from URLs; otherwise, false.

IconsPath

Gets the path to folder containing the icons used in the umbraco backoffice (/umbraco/assets/icons by default).

Declaration

public string IconsPath { get; }

Property Value

Type	Description
System.String	The icons path.

LocalTempPath

Gets the location of temporary files.

Declaration

public string LocalTempPath { get; }

Property Value

Type	Description
System.String

LocalTempStorageLocation

Gets the configuration for the location of temporary files.

Declaration

public LocalTempStorage LocalTempStorageLocation { get; }

Property Value

Type	Description
LocalTempStorage

Path

Gets the path to umbraco's root directory (/umbraco by default).

Declaration

public string Path { get; }

Property Value

Type	Description
System.String	The path.

ReservedPaths

Gets the reserved paths from web.config

Declaration

public string ReservedPaths { get; }

Property Value

Type	Description
System.String	The reserved paths.

ReservedUrls

Gets the reserved URLs from web.config.

Declaration

public string ReservedUrls { get; }

Property Value

Type	Description
System.String	The reserved URLs.

SanitizeTinyMce

Returns true if TinyMCE scripting sanitization should be applied

Declaration

public bool SanitizeTinyMce { get; }

Property Value

Type	Description
System.Boolean

Remarks

The default value is false

SqlWriteLockTimeOut

An int value representing the time in milliseconds to lock the database for a write operation

Declaration

public int SqlWriteLockTimeOut { get; }

Property Value

Type	Description
System.Int32	The timeout in milliseconds.

Remarks

The default value is 5000 milliseconds

TimeOutInMinutes

Gets the time out in minutes.

Declaration

public int TimeOutInMinutes { get; }

Property Value

Type	Description
System.Int32	The time out in minutes.

UseHttps

Gets a value indicating whether umbraco should force a secure (https) connection to the backoffice.

Declaration

public bool UseHttps { get; }

Property Value

Type	Description
System.Boolean

VersionCheckPeriod

Returns the number of days that should take place between version checks.

Declaration

public int VersionCheckPeriod { get; }

Property Value

Type	Description
System.Int32	The version check period in days (0 = never).

Methods

HasSmtpServerConfigured(String)

Declaration

public static bool HasSmtpServerConfigured(string appPath)

Parameters

Type	Name	Description
System.String	appPath

Returns

Type	Description
System.Boolean