Class Host

Contains most of the host settings.

Inheritance

System.Object

BaseEntityInfo

Host

Inherited Members

BaseEntityInfo.CreatedByUserID

BaseEntityInfo.CreatedOnDate

BaseEntityInfo.LastModifiedByUserID

BaseEntityInfo.LastModifiedOnDate

BaseEntityInfo.CreatedByUser(Int32)

BaseEntityInfo.LastModifiedByUser(Int32)

BaseEntityInfo.FillInternal(IDataReader)

BaseEntityInfo.CloneBaseProperties(BaseEntityInfo, BaseEntityInfo)

Namespace: DotNetNuke.Entities.Host

Assembly: DotNetNuke.dll

Syntax

public class Host : BaseEntityInfo

Properties

AdminMembershipResetLinkValidity

Gets set length of time (in minutes) that reset links are valid for - default is 24 hours (1440 min).

Declaration

public static int AdminMembershipResetLinkValidity { get; }

Property Value

Type	Description
System.Int32

AllowControlPanelToDetermineVisibility

Gets a value indicating whether setting to control where the control panel is loaded by the core and allowed to control it's own visibility. this is useful when the control panel needs to be visible for all users regardless of edit page/module permissions. it's also for backwards compatibility, prior to 7.2 the control panel was always loaded.

Declaration

public static bool AllowControlPanelToDetermineVisibility { get; }

Property Value

Type	Description
System.Boolean

AllowedExtensionWhitelist

Gets the allowed file extensions.

Declaration

public static FileExtensionWhitelist AllowedExtensionWhitelist { get; }

Property Value

Type	Description
FileExtensionWhitelist

AsyncTimeout

Gets get the time, in seconds, before asynchronous postbacks time out if no response is received.

Declaration

public static int AsyncTimeout { get; }

Property Value

Type	Description
System.Int32

AuthenticatedCacheability

Gets the AuthenticatedCacheability.

Declaration

public static string AuthenticatedCacheability { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to HttpCacheability.ServerAndNoCache.

AutoAccountUnlockDuration

Gets the AutoAccountUnlockDuration.

Declaration

public static int AutoAccountUnlockDuration { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 10.

CdnEnabled

Gets a value indicating whether or not CDN has been enabled for all registered javascript libraries.

Declaration

public static bool CdnEnabled { get; }

Property Value

Type	Description
System.Boolean

CheckUpgrade

Gets a value indicating whether gets whether the Upgrade Indicator is enabled.

Declaration

public static bool CheckUpgrade { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

ControlPanel

Gets the Control Panel.

Declaration

public static string ControlPanel { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to glbDefaultControlPanel constant.

CrmEnableCompositeFiles

Gets a value indicating whether indicates whether Composite Files are enabled at the host level.

Declaration

public static bool CrmEnableCompositeFiles { get; }

Property Value

Type	Description
System.Boolean

CrmMinifyCss

Gets a value indicating whether indicates whether CSS Minification is enabled at the host level.

Declaration

public static bool CrmMinifyCss { get; }

Property Value

Type	Description
System.Boolean

CrmMinifyJs

Gets a value indicating whether indicates whether JS Minification is enabled at the host level.

Declaration

public static bool CrmMinifyJs { get; }

Property Value

Type	Description
System.Boolean

CrmVersion

Gets the Client Resource Management version number.

Declaration

public static int CrmVersion { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 1.

DebugMode

Gets a value indicating whether gets whether the installation runs in debug mode. This property can be used by the framework and extensions alike to write more verbose logs/onscreen information, etc. It is set in the host settings page.

Declaration

public static bool DebugMode { get; }

Property Value

Type	Description
System.Boolean

DefaultAdminContainer

Gets the Default Admin Container.

Declaration

public static string DefaultAdminContainer { get; }

Property Value

Type	Description
System.String

DefaultAdminSkin

Gets the Default Admin Skin.

Declaration

public static string DefaultAdminSkin { get; }

Property Value

Type	Description
System.String

DefaultDocType

Gets the Default Doc Type.

Declaration

public static string DefaultDocType { get; }

Property Value

Type	Description
System.String

DefaultEndUserExtensionWhitelist

Gets default list of extensions an end user is allowed to upload.

Declaration

public static FileExtensionWhitelist DefaultEndUserExtensionWhitelist { get; }

Property Value

Type	Description
FileExtensionWhitelist

DefaultPortalContainer

Gets the Default Portal Container.

Declaration

public static string DefaultPortalContainer { get; }

Property Value

Type	Description
System.String

DefaultPortalSkin

Gets the Default Portal Skin.

Declaration

public static string DefaultPortalSkin { get; }

Property Value

Type	Description
System.String

DemoPeriod

Gets the Demo Period for new portals.

Declaration

public static int DemoPeriod { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to -1.

DemoSignup

Gets a value indicating whether gets whether demo signups are enabled.

Declaration

public static bool DemoSignup { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

DisableEditBar

Gets a value indicating whether the default Edit Bar is disabled.

Declaration

public static bool DisableEditBar { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to false.

DisplayBetaNotice

Gets a value indicating whether gets whether to dislpay the beta notice.

Declaration

public static bool DisplayBetaNotice { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

DisplayCopyright

Gets a value indicating whether gets whether to dislpay the copyright.

Declaration

public static bool DisplayCopyright { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

EnableBannedList

Gets a value indicating whether enable checking for banned words when setting password during registration.

Declaration

public static bool EnableBannedList { get; }

Property Value

Type	Description
System.Boolean

EnableBrowserLanguage

Gets a value indicating whether gets whether Browser Language Detection is Enabled.

Declaration

public static bool EnableBrowserLanguage { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

EnableContentLocalization

Contains most of the host settings.

Declaration

public static bool EnableContentLocalization { get; }

Property Value

Type	Description
System.Boolean

EnableCustomModuleCssClass

Gets a value indicating whether gets whether a css class based on the Module Name is automatically rendered.

Declaration

public static bool EnableCustomModuleCssClass { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

EnableFileAutoSync

Gets a value indicating whether gets whether File AutoSync is Enabled.

Declaration

public static bool EnableFileAutoSync { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EnableIPChecking

Gets a value indicating whether enable whether the IP address of the user is checked against a list during login.

Declaration

public static bool EnableIPChecking { get; }

Property Value

Type	Description
System.Boolean

EnableModuleOnLineHelp

Gets a value indicating whether gets whether Module Online Help is Enabled.

Declaration

public static bool EnableModuleOnLineHelp { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EnableMsAjaxCdn

Gets a value indicating whether gets whether to use a hosted version of the MS Ajax Library.

Declaration

public static bool EnableMsAjaxCdn { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EnablePasswordHistory

Gets a value indicating whether enable whether a previous passwords are stored to check if user is reusing them.

Declaration

public static bool EnablePasswordHistory { get; }

Property Value

Type	Description
System.Boolean

EnableRequestFilters

Gets a value indicating whether gets whether the Request Filters are Enabled.

Declaration

public static bool EnableRequestFilters { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EnableSMTPSSL

Gets a value indicating whether gets whether SSL is Enabled for SMTP.

Declaration

public static bool EnableSMTPSSL { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EnableStrengthMeter

Gets a value indicating whether enable whether a client-side password strength meter is shown on registration screen.

Declaration

public static bool EnableStrengthMeter { get; }

Property Value

Type	Description
System.Boolean

EnableTelerikCdn

Gets a value indicating whether gets whether to use a hosted version of the Telerik Library.

Declaration

public static bool EnableTelerikCdn { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EnableUrlLanguage

Gets a value indicating whether gets whether to use the Language in the Url.

Declaration

public static bool EnableUrlLanguage { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

EnableUsersOnline

Gets a value indicating whether gets whether Users Online are Enabled.

Declaration

public static bool EnableUsersOnline { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

EventLogBuffer

Gets a value indicating whether gets whether the Event Log Buffer is Enabled.

Declaration

public static bool EventLogBuffer { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

GUID

Gets the GUID.

Declaration

public static string GUID { get; }

Property Value

Type	Description
System.String

HelpURL

Gets the Help URL.

Declaration

public static string HelpURL { get; }

Property Value

Type	Description
System.String

HostCurrency

Gets the Host Currency.

Declaration

public static string HostCurrency { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to USD.

HostEmail

Gets the Host Email.

Declaration

public static string HostEmail { get; }

Property Value

Type	Description
System.String

HostFee

Gets the Host Fee.

Declaration

public static double HostFee { get; }

Property Value

Type	Description
System.Double

Remarks

Defaults to 0.

HostPortalID

Gets the Host Portal's PortalId.

Declaration

public static int HostPortalID { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to Null.NullInteger.

HostSpace

Gets the Host Space.

Declaration

public static double HostSpace { get; }

Property Value

Type	Description
System.Double

Remarks

Defaults to 0.

HostTitle

Gets the Host Title.

Declaration

public static string HostTitle { get; }

Property Value

Type	Description
System.String

HostURL

Gets the Host URL.

Declaration

public static string HostURL { get; }

Property Value

Type	Description
System.String

HttpCompressionAlgorithm

Gets the HttpCompression Algorithm.

Declaration

public static int HttpCompressionAlgorithm { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to Null.NullInteger(None).

IsLocked

Gets a value indicating whether get a value indicating whether to put the entire instance into maintenance mode.

Declaration

public static bool IsLocked { get; }

Property Value

Type	Description
System.Boolean

jQueryDebug

Gets a value indicating whether gets whether to use the minified or debug version of the jQuery scripts.

Declaration

public static bool jQueryDebug { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

jQueryHosted

Gets a value indicating whether gets whether to use a hosted version of the jQuery script file.

Declaration

public static bool jQueryHosted { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

jQueryMigrateUrl

Gets the Url for a hosted version of jQuery Migrate plugin.

Declaration

public static string jQueryMigrateUrl { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to the DefaultHostedUrl constant in the jQuery class. The framework will default to the latest released 1.x version hosted on Google.

jQueryUIUrl

Gets the Url for a hosted version of jQuery UI.

Declaration

public static string jQueryUIUrl { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to the DefaultUIHostedUrl constant in the jQuery class. The framework will default to the latest released 1.x version hosted on Google.

jQueryUrl

Gets the Url for a hosted version of jQuery.

Declaration

public static string jQueryUrl { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to the DefaultHostedUrl constant in the jQuery class. The framework will default to the latest released 1.x version hosted on Google.

MembershipDaysBeforePasswordReuse

Gets the number of days that must pass before a password can be reused - default is 0 (i.e. password reuse is only governed by EnablePasswordHistory and MembershipNumberPasswords).

Declaration

public static int MembershipDaysBeforePasswordReuse { get; }

Property Value

Type	Description
System.Int32

MembershipFailedIPException

Gets the HTTP Status code returned if IP address filtering is enabled on login and the users IP does not meet criteria -default is 403.

Declaration

public static string MembershipFailedIPException { get; }

Property Value

Type	Description
System.String

MembershipNumberPasswords

Gets set number of passwords stored for password change comparison operations - default is 5.

Declaration

public static int MembershipNumberPasswords { get; }

Property Value

Type	Description
System.Int32

MembershipResetLinkValidity

Gets set length of time (in minutes) that reset links are valid for - default is 60.

Declaration

public static int MembershipResetLinkValidity { get; }

Property Value

Type	Description
System.Int32

MessageSchedulerBatchSize

Gets size of the batch used to determine how many emails are sent per CoreMessaging Scheduler run.

Declaration

public static int MessageSchedulerBatchSize { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 50.

ModuleCachingMethod

Gets the Module Caching method.

Declaration

public static string ModuleCachingMethod { get; }

Property Value

Type	Description
System.String

PageCachingMethod

Gets the Page Caching method.

Declaration

public static string PageCachingMethod { get; }

Property Value

Type	Description
System.String

PageQuota

Gets the Page Quota.

Declaration

public static int PageQuota { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 0.

PageStatePersister

Gets the PageState Persister.

Declaration

public static string PageStatePersister { get; }

Property Value

Type	Description
System.String

ParticipateInImprovementProg

Gets a value indicating whether gets whether the installation participates in the improvements program.

Declaration

public static bool ParticipateInImprovementProg { get; }

Property Value

Type	Description
System.Boolean

PasswordExpiry

Gets the Password Expiry.

Declaration

public static int PasswordExpiry { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 0.

PasswordExpiryReminder

Gets the Password Expiry Reminder window.

Declaration

public static int PasswordExpiryReminder { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 7 (1 week).

PaymentProcessor

Gets the Payment Processor.

Declaration

public static string PaymentProcessor { get; }

Property Value

Type	Description
System.String

PerformanceSetting

Gets or sets the PerformanceSettings.

Declaration

public static Globals.PerformanceSettings PerformanceSetting { get; set; }

Property Value

Type	Description
Globals.PerformanceSettings

Remarks

Defaults to PerformanceSettings.ModerateCaching.

ProcessorPassword

Gets the Payment Processor Password.

Declaration

public static string ProcessorPassword { get; }

Property Value

Type	Description
System.String

ProcessorUserId

Gets the Payment Processor User Id.

Declaration

public static string ProcessorUserId { get; }

Property Value

Type	Description
System.String

ProxyPassword

Gets the Proxy Server Password.

Declaration

public static string ProxyPassword { get; }

Property Value

Type	Description
System.String

ProxyPort

Gets the Proxy Server Port.

Declaration

public static int ProxyPort { get; }

Property Value

Type	Description
System.Int32

ProxyServer

Gets the Proxy Server.

Declaration

public static string ProxyServer { get; }

Property Value

Type	Description
System.String

ProxyUsername

Gets the Proxy Server UserName.

Declaration

public static string ProxyUsername { get; }

Property Value

Type	Description
System.String

RememberCheckbox

Gets a value indicating whether gets whether to use the remember me checkbox.

Declaration

public static bool RememberCheckbox { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

SchedulerdelayAtAppStart

Gets the delayAtAppStart value.

Declaration

public static int SchedulerdelayAtAppStart { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults is 1 min(60 sec).

SchedulerMode

Gets the Scheduler Mode.

Declaration

public static SchedulerMode SchedulerMode { get; }

Property Value

Type	Description
SchedulerMode

Remarks

Defaults to SchedulerMode.TIMER_METHOD.

SearchIncludeCommon

Gets a value indicating whether gets whether to inlcude Common Words in the Search Index.

Declaration

public static bool SearchIncludeCommon { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

SearchIncludedTagInfoFilter

Gets the filter used for inclusion of tag info.

Declaration

public static string SearchIncludedTagInfoFilter { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to "".

SearchIncludeNumeric

Gets a value indicating whether gets whether to inlcude Numbers in the Search Index.

Declaration

public static bool SearchIncludeNumeric { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

SearchMaxWordlLength

Gets the maximum Search Word length to index.

Declaration

public static int SearchMaxWordlLength { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 25.

SearchMinWordlLength

Gets the maximum Search Word length to index.

Declaration

public static int SearchMinWordlLength { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 3.

ShowCriticalErrors

Gets a value indicating whether display the text of errors injected via the error querystring parameter.

Declaration

public static bool ShowCriticalErrors { get; }

Property Value

Type	Description
System.Boolean

SiteLogBuffer

Gets the Site Log Buffer size.

Declaration

public static int SiteLogBuffer { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 1.

SiteLogHistory

Gets the Site Log History.

Declaration

public static int SiteLogHistory { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to -1.

SiteLogStorage

Gets the Site Log Storage location.

Declaration

public static string SiteLogStorage { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to "D".

SMTPAuthentication

Gets the SMTP Authentication.

Declaration

public static string SMTPAuthentication { get; }

Property Value

Type	Description
System.String

SMTPAuthProvider

Gets the currently configured SMTP OAuth provider if existing, for the current portal if portal SMTP enabled, otherwise for the installation.

Declaration

public static string SMTPAuthProvider { get; }

Property Value

Type	Description
System.String

Remarks

Defaults to empty string.

SMTPConnectionLimit

Gets the SMTP Connection Limit.

Declaration

public static int SMTPConnectionLimit { get; }

Property Value

Type	Description
System.Int32

SMTPMaxIdleTime

Gets the SMTP MaxIdleTime.

Declaration

public static int SMTPMaxIdleTime { get; }

Property Value

Type	Description
System.Int32

SMTPPassword

Gets the SMTP Password.

Declaration

public static string SMTPPassword { get; }

Property Value

Type	Description
System.String

SMTPServer

Gets the SMTP Server.

Declaration

public static string SMTPServer { get; }

Property Value

Type	Description
System.String

SMTPUsername

Gets the SMTP Username.

Declaration

public static string SMTPUsername { get; }

Property Value

Type	Description
System.String

SslDomain

Gets the domain used when upgrade wizard forced to shown in ssl channel.

Declaration

public static string SslDomain { get; }

Property Value

Type	Description
System.String

TelerikCdnBasicUrl

Gets get Telerik CDN Basic Path.

Declaration

public static string TelerikCdnBasicUrl { get; }

Property Value

Type	Description
System.String

TelerikCdnSecureUrl

Gets get Telerik CDN Secure Path.

Declaration

public static string TelerikCdnSecureUrl { get; }

Property Value

Type	Description
System.String

ThrowCBOExceptions

Gets a value indicating whether gets whether Exceptions are rethrown.

Declaration

public static bool ThrowCBOExceptions { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

UnauthenticatedCacheability

Contains most of the host settings.

Declaration

public static string UnauthenticatedCacheability { get; }

Property Value

Type	Description
System.String

UpgradeForceSsl

Gets a value indicating whether whether force upgrade wizard open in ssl channel.

Declaration

public static bool UpgradeForceSsl { get; }

Property Value

Type	Description
System.Boolean

UseCustomErrorMessages

Gets a value indicating whether gets whether Custom Error Messages is Enabled.

Declaration

public static bool UseCustomErrorMessages { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

UseFriendlyUrls

Gets a value indicating whether gets whether Friendly Urls is Enabled.

Declaration

public static bool UseFriendlyUrls { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to False.

UserQuota

Gets the User Quota.

Declaration

public static int UserQuota { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 0.

UsersOnlineTimeWindow

Gets the window to use in minutes when determining if the user is online.

Declaration

public static int UsersOnlineTimeWindow { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 15.

WebRequestTimeout

Gets the WebRequest Timeout value.

Declaration

public static int WebRequestTimeout { get; }

Property Value

Type	Description
System.Int32

Remarks

Defaults to 10000.

Extension Methods

JsonExtensionsWeb.ToJson(Object)