Class Settings

[ServiceConfiguration(FactoryMember = "Instance")]
public class Settings : ConfigurationElementBase

public Settings()

[Obsolete("Sites are not defined in configuration anymore. Use SiteDefinitionRepository to get list of sites.")]
public static IDictionary<string, Settings> All { get; protected set; }

[TimeSpanValidator]
[Obsolete("The legacy edit mode has been removed")]
public TimeSpan AutoSaveInterval { get; set; }

public int BackgroundCopyThreshold { get; set; }

[Obsolete("The connection string is managed by configuration in EPiServer.Data")]
public string ConnectionStringName { get; set; }

[TimeSpanValidator]
public TimeSpan ContentVersionCacheSlidingExpiration { get; set; }

[TimeSpanValidator]
[Obsolete("Database settings is managed by configuration in EPiServer.Data")]
public TimeSpan DatabaseQueryTimeout { get; set; }

[Obsolete("Database settings is managed by configuration in EPiServer.Data")]
public int DeadlockRetries { get; set; }

[TimeSpanValidator]
[Obsolete("Database settings is managed by configuration in EPiServer.Data")]
public TimeSpan DeadlockRetryDelay { get; set; }

public string DefaultNotificationEmailAddress { get; set; }

public string DefaultNotificationEmailDisplayName { get; set; }

[BoolValidator]
public bool DisableVersionDeletion { get; set; }

[TimeSpanValidator]
[Obsolete("The legacy edit mode has been removed")]
public TimeSpan DraftRetainPeriod { get; set; }

[BoolValidator]
public bool EnableLogOfContentSave { get; set; }

[BoolValidator]
public bool EnableModelSyncCommit { get; set; }

[BoolValidator]
public bool EnablePerformanceCounters { get; set; }

[BoolValidator]
public bool EnableSavingOfConfigurationToDatabase { get; set; }

[BoolValidator]
public bool EnableScheduler { get; set; }

[BoolValidator]
[Obsolete("Used by the blog API that is not longer shipped with the product")]
public bool EnableXmlRpcHeader { get; set; }

[CustomRegexStringValidator("^(?:~/|/)(?:[a-zA-Z0-9\\-_\\.!\\~\\*'\\(\\):@&=\\+\\$,]+/)*", "The value must be a relative adress, ie it must start with a slash or tilde-slash.")]
[Obsolete("Built-in functionality to send e-mail's on exceptions has been removed")]
public string ErrorMailHandler { get; set; }

[TimeSpanValidator]
public TimeSpan ExpirationNotificationPeriod { get; set; }

[Obsolete("There is only one Settings which is available through 'Instance'")]
public static Settings FallbackSettings { get; set; }

[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public int GlobalBlockFolderId { get; set; }

public string GlobalErrorHandling { get; set; }

[MailAddressValidator]
[Obsolete("Built-in functionality to send e-mail's on exceptions has been removed")]
public MailAddress GlobalErrorMail { get; set; }

public string GoogleMapsApiV3Url { get; set; }

public HttpCacheability HttpCacheability { get; set; }

[TimeSpanValidator]
public TimeSpan HttpCacheExpiration { get; set; }

public string HttpCacheVaryByCustom { get; set; }

public string[] HttpCacheVaryByParams { get; set; }

public string IISHiddenSegments { get; set; }

[TimeSpanValidator]
[Obsolete("Indexing is done by EPiServer Search or Find")]
public TimeSpan IndexingDelayAfterPublish { get; set; }

[BoolValidator]
[Obsolete("Enabling indexing is controlled by SearchSettings.Config.Active. Can be changed by the 'active' attribute on the 'episerver.search' section of the config.", false)]
public bool IndexingTextEnabled { get; set; }

[Obsolete("This setting is no longer used since an dedicated search engine is used for indexing content")]
public string IndexingTextRegExp { get; set; }

public static Settings Instance { get; set; }

public int MaxContentsPerDatabaseRequest { get; set; }

public int MirroringMonitoringMaxDataPerJob { get; set; }

public string MirroringSource { get; set; }

[TimeSpanValidator]
public TimeSpan MonitoredTaskTruncateLimit { get; set; }

public EPiServerCompatibility OperationCompatibility { get; set; }

[TimeSpanValidator]
public TimeSpan PageCacheSlidingExpiration { get; set; }

[CustomRegexStringValidator("^[a-zA-Z0-9]{1,255}$", "The string must be a combination of alphanumericals, dots (.) and dashes (-) up to 256 characters long, e.g. 'site.com' or 'MySite-2'.")]
public string PageFolderVirtualPathProviderName { get; set; }

[Obsolete("This setting is not being used anymore due to removal of the legacy office integration")]
public int PageOfficeStartId { get; set; }

[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public int PageRootId { get; set; }

[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public int PageStartId { get; set; }

[BoolValidator]
public bool PageUseBrowserLanguagePreferences { get; set; }

[BoolValidator]
public bool PageValidateTemplate { get; set; }

[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public int PageWastebasketId { get; set; }

[Obsolete("Sites are not defined in configuration anymore. Use SiteDefinitionRepository to define sites.")]
public SiteElement Parent { get; }

[TimeSpanValidator]
public TimeSpan PermanentEditRetainPeriod { get; set; }

[Obsolete("Not used anymore, was part of older events system")]
public string[] RemoteCacheListenerShortNames { get; set; }

[BoolValidator]
public bool RemoteInvalidateVersionChanges { get; set; }

[TimeSpanValidator]
public TimeSpan RemotePageCacheSlidingExpiration { get; set; }

public int RemoteWebServiceCulture { get; set; }

public Func<int> RootPageResolver { get; set; }

[BoolValidator]
public bool SgmlParserDecodeCharEntities { get; set; }

[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public int SiteBlockFolderId { get; set; }

[CustomRegexStringValidator("^([\\x20\\w0-9\\.-]{0,256})$", "The string must be either an empty string or any combination of alphanumericals, dots (.), dashes (-) and spaces up to 256 characters long, e.g. 'site.com' or 'My Site-2'.")]
[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public string SiteDisplayName { get; set; }

[WebUrlValidator]
[Obsolete("Use EPiServer.Web.SiteDefinition instead")]
public Uri SiteUrl { get; set; }

public Func<Uri> SiteUrlResolver { get; set; }

public Func<int> StartPageResolver { get; set; }

[BoolValidator]
public bool StrictLanguageRouting { get; set; }

public int StringCompressionThreshold { get; set; }

public int StringDelayedLoadThreshold { get; set; }

public string SubscriptionHandler { get; set; }

[Obsolete("The legacy edit mode has been removed")]
public int UIDefaultPanelTab { get; set; }

[BoolValidator]
public bool UIDefaultValueForSetChangedOnPublish { get; set; }

[Obsolete("Only used by legacy CMS 5 editor")]
public string UIEditorColors { get; set; }

[CustomRegexStringValidator("^[\\s]*$|^(?:(?:~/|/)(?:[a-zA-Z0-9\\-_\\.!\\~\\*'\\(\\):@&=\\+\\$,]+/)*\\w+[\\.\\-\\w]+\\w+[\\s]*,[\\s]*)*(?:(?:~/|/)(?:[a-zA-Z0-9\\-_\\.!\\~\\*'\\(\\):@&=\\+\\$,]+/)*\\w+[\\.\\-\\w]+\\w+){1}[\\s]*$", "The string must contain one or more comma-separated application- or host-relative virtual file paths, e.g. '~/folder/some.file, /another.file'.")]
public string UIEditorCssPaths { get; set; }

[CustomRegexStringValidator("^([a-z]|[A-Z])+(\\|([a-z]|[A-Z])+)*$", "string should be a '|' separated string of html tags")]
[Obsolete("Only used by legacy CMS 5 editor")]
public string UIEditorUnformattingPersistedTags { get; set; }

[ColorValidator]
[Obsolete]
public Color UIImageTransparencyReplacement { get; set; }

[BoolValidator]
public bool UIKeepUserLoggedOn { get; set; }

public int UIMaxVersions { get; set; }

[BoolValidator]
public bool UIOptimizeTreeForSpeed { get; set; }

public string UISafeHtmlTags { get; set; }

[BoolValidator]
public bool UIShowGlobalizationUserInterface { get; set; }

public string UITheme { get; set; }

[UrlValidator]
public Uri UIUrl { get; set; }

public string UrlPreventRewriteAttrebute { get; set; }

public string UrlRebaseKind { get; set; }

public string UrlRewriteExtension { get; set; }

[Obsolete("The legacy edit mode has been removed")]
public bool UseLegacyEditMode { get; set; }

public bool UseLegacyShortcutRouting { get; set; }

[BoolValidator]
public bool UseStartPublishForDelayedPublishUntil { get; set; }

[UrlValidator]
public Uri UtilUrl { get; set; }

public string Version { get; }

public static void CopyValues(Settings source, Settings target)

[Obsolete("This method does nothing since configuration is always loaded when required")]
public static void InitializeAllSettings()

[Obsolete("Use ConfigurationSource.Instance = new FileConfigurationSource(value) to replace global configuration or use GlobalConfigurationManager to Load and Save configuration files")]
public static void InitializeAllSettings(Configuration config)

[Obsolete("Use Settings.Instance to get common settings for sites or SiteDefinitionResolver to get site specific settings.")]
public static Settings MapHostToSettings(string hostName, bool fallback)

[Obsolete("To get 'common' Settings for sites use Settings.Instance. To get site specific settings use EPiServer.Web.SiteDefinitionResolver or EPiServer.Web.SiteDefinitionRepository")]
public static Settings MapUrlToSettings(Uri url)

[Obsolete("Use GlobalConfigurationManager.Load and Save to make changes to the configuration file")]
public void Save()

[Obsolete("Use GlobalConfigurationManager.Load and Save to make changes to the configuration file")]
public void Save(RestartMode mode)

public void ValidateRuntimeSettings()