Search Results for

    Show / Hide Table of Contents
    View Source

    Class GlobalSettings

    Typed configuration options for global settings.

    Inheritance
    System.Object
    Namespace: Umbraco.Cms.Core.Configuration.Models
    Assembly: Umbraco.Core.dll
    Syntax
    public class GlobalSettings

    Properties

    View Source

    DatabaseFactoryServerVersion

    Gets or sets a value for the database factory server version.

    Declaration
    public string DatabaseFactoryServerVersion { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    DatabaseServerMessenger

    Gets or sets a value for the database server messenger settings.

    Declaration
    public DatabaseServerMessengerSettings DatabaseServerMessenger { get; set; }
    Property Value
    Type Description
    DatabaseServerMessengerSettings
    View Source

    DatabaseServerRegistrar

    Gets or sets a value for the database server registrar settings.

    Declaration
    public DatabaseServerRegistrarSettings DatabaseServerRegistrar { get; set; }
    Property Value
    Type Description
    DatabaseServerRegistrarSettings
    View Source

    DefaultUILanguage

    Gets or sets a value for the default UI language.

    Declaration
    public string DefaultUILanguage { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    DisableElectionForSingleServer

    Gets or sets a value indicating whether to disable the election for a single server.

    Declaration
    public bool DisableElectionForSingleServer { get; set; }
    Property Value
    Type Description
    System.Boolean
    View Source

    DistributedLockingMechanism

    Gets or sets a value representing the DistributedLockingMechanism to use.

    Declaration
    public string DistributedLockingMechanism { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    DistributedLockingReadLockDefaultTimeout

    Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed read lock.

    Declaration
    public TimeSpan DistributedLockingReadLockDefaultTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    Remarks

    The default value is 60 seconds.

    View Source

    DistributedLockingWriteLockDefaultTimeout

    Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed write lock.

    Declaration
    public TimeSpan DistributedLockingWriteLockDefaultTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    Remarks

    The default value is 5 seconds.

    View Source

    ForceCombineUrlPathLeftToRight

    Force url paths to be left to right, even when the culture has right to left text

    Declaration
    public bool ForceCombineUrlPathLeftToRight { get; set; }
    Property Value
    Type Description
    System.Boolean
    Examples

    For the following hierarchy

    • Root (/ar)
    • 1 (/ar/1)
    • 2 (/ar/1/2)
      • 3 (/ar/1/2/3)
        • 3 (/ar/1/2/3/4) When forced
    • https://www.umbraco.com/ar/1/2/3/4 when not
    • https://www.umbraco.com/ar/4/3/2/1
    View Source

    HideTopLevelNodeFromPath

    Gets or sets a value indicating whether to hide the top level node from the path.

    Declaration
    public bool HideTopLevelNodeFromPath { get; set; }
    Property Value
    Type Description
    System.Boolean
    View Source

    IconsPath

    Gets or sets a value for the Umbraco icons path.

    Declaration
    public string IconsPath { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    TODO: Umbraco cannot be hard coded here that is what UmbracoPath is for so this should not be a normal get set it has to have dynamic ability to return the correct path given UmbracoPath if this hasn't been explicitly set.

    View Source

    Id

    Gets or sets the telemetry ID.

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    InstallMissingDatabase

    Gets or sets a value indicating whether to install the database when it is missing.

    Declaration
    public bool InstallMissingDatabase { get; set; }
    Property Value
    Type Description
    System.Boolean
    View Source

    IsPickupDirectoryLocationConfigured

    Gets a value indicating whether there is a physical pickup directory configured.

    Declaration
    public bool IsPickupDirectoryLocationConfigured { get; }
    Property Value
    Type Description
    System.Boolean
    View Source

    IsSmtpServerConfigured

    Gets a value indicating whether SMTP is configured.

    Declaration
    public bool IsSmtpServerConfigured { get; }
    Property Value
    Type Description
    System.Boolean
    View Source

    MainDomKeyDiscriminator

    Gets or sets a value to discriminate MainDom boundaries.

    Generally the default should suffice but useful for advanced scenarios e.g. azure deployment slot based zero downtime deployments.

    Declaration
    public string MainDomKeyDiscriminator { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    MainDomLock

    Gets or sets a value for the main dom lock.

    Declaration
    public string MainDomLock { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    MainDomReleaseSignalPollingInterval

    Gets or sets the duration (in milliseconds) for which the MainDomLock release signal polling task should sleep.

    Declaration
    public int MainDomReleaseSignalPollingInterval { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Doesn't apply to MainDomSemaphoreLock.

    The default value is 2000ms.

    View Source

    NoNodesViewPath

    Gets or sets a value for the path to the no content view.

    Declaration
    public string NoNodesViewPath { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    ReservedPaths

    Gets or sets a value for the reserved paths (must end with a comma).

    Declaration
    public string ReservedPaths { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    ReservedUrls

    Gets or sets a value for the reserved URLs (must end with a comma).

    Declaration
    public string ReservedUrls { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    SanitizeTinyMce

    Gets or sets a value indicating whether TinyMCE scripting sanitization should be applied.

    Declaration
    public bool SanitizeTinyMce { get; set; }
    Property Value
    Type Description
    System.Boolean
    View Source

    ShowMaintenancePageWhenInUpgradeState

    Declaration
    public bool ShowMaintenancePageWhenInUpgradeState { get; set; }
    Property Value
    Type Description
    System.Boolean
    View Source

    Smtp

    Gets or sets a value for the SMTP settings.

    Declaration
    public SmtpSettings Smtp { get; set; }
    Property Value
    Type Description
    SmtpSettings
    View Source

    TimeOut

    Gets or sets a value for the back-office login timeout.

    Declaration
    public TimeSpan TimeOut { get; set; }
    Property Value
    Type Description
    TimeSpan
    View Source

    UmbracoCssPath

    Gets or sets a value for the Umbraco CSS path.

    Declaration
    public string UmbracoCssPath { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    UmbracoMediaPath

    Gets or sets a value for the Umbraco media request path.

    Declaration
    public string UmbracoMediaPath { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    UmbracoMediaPhysicalRootPath

    Gets or sets a value for the physical Umbraco media root path (falls back to UmbracoMediaPath when empty).

    Declaration
    public string UmbracoMediaPhysicalRootPath { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    If the value is a virtual path, it's resolved relative to the webroot.

    View Source

    UmbracoPath

    Gets or sets a value for the Umbraco back-office path.

    Declaration
    public string UmbracoPath { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    UmbracoScriptsPath

    Gets or sets a value for the Umbraco scripts path.

    Declaration
    public string UmbracoScriptsPath { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    UseHttps

    Gets or sets a value indicating whether HTTPS should be used.

    Declaration
    public bool UseHttps { get; set; }
    Property Value
    Type Description
    System.Boolean
    View Source

    VersionCheckPeriod

    Gets or sets a value for the version check period in days.

    Declaration
    public int VersionCheckPeriod { get; set; }
    Property Value
    Type Description
    System.Int32
    • Improve this Doc
    • View Source
    In This Article
    • Properties
      • DatabaseFactoryServerVersion
      • DatabaseServerMessenger
      • DatabaseServerRegistrar
      • DefaultUILanguage
      • DisableElectionForSingleServer
      • DistributedLockingMechanism
      • DistributedLockingReadLockDefaultTimeout
      • DistributedLockingWriteLockDefaultTimeout
      • ForceCombineUrlPathLeftToRight
      • HideTopLevelNodeFromPath
      • IconsPath
      • Id
      • InstallMissingDatabase
      • IsPickupDirectoryLocationConfigured
      • IsSmtpServerConfigured
      • MainDomKeyDiscriminator
      • MainDomLock
      • MainDomReleaseSignalPollingInterval
      • NoNodesViewPath
      • ReservedPaths
      • ReservedUrls
      • SanitizeTinyMce
      • ShowMaintenancePageWhenInUpgradeState
      • Smtp
      • TimeOut
      • UmbracoCssPath
      • UmbracoMediaPath
      • UmbracoMediaPhysicalRootPath
      • UmbracoPath
      • UmbracoScriptsPath
      • UseHttps
      • VersionCheckPeriod
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX