Class PortalSettings

Inheritance

object

BaseEntityInfo

PortalSettings

Implements

IPropertyAccess

IPortalSettings

Inherited Members

BaseEntityInfo.CreatedByUser(int)

BaseEntityInfo.LastModifiedByUser(int)

BaseEntityInfo.FillInternal(IDataReader)

BaseEntityInfo.CloneBaseProperties(BaseEntityInfo, BaseEntityInfo)

BaseEntityInfo.CreatedByUserID

BaseEntityInfo.CreatedOnDate

BaseEntityInfo.LastModifiedByUserID

BaseEntityInfo.LastModifiedOnDate

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Entities.Portals

Assembly: DotNetNuke.dll

Syntax

public class PortalSettings : BaseEntityInfo, IPropertyAccess, IPortalSettings

Constructors

PortalSettings()

Declaration

public PortalSettings()

PortalSettings(PortalInfo)

Declaration

public PortalSettings(PortalInfo portal)

Parameters

Type	Name	Description
PortalInfo	portal

PortalSettings(int)

Declaration

public PortalSettings(int portalId)

Parameters

Type	Name	Description
int	portalId

PortalSettings(int, PortalAliasInfo)

Declaration

public PortalSettings(int tabId, PortalAliasInfo portalAliasInfo)

Parameters

Type	Name	Description
int	tabId
PortalAliasInfo	portalAliasInfo

PortalSettings(int, PortalInfo)

Declaration

public PortalSettings(int tabId, PortalInfo portal)

Parameters

Type	Name	Description
int	tabId
PortalInfo	portal

PortalSettings(int, int)

Declaration

public PortalSettings(int tabId, int portalId)

Parameters

Type	Name	Description
int	tabId
int	portalId

Properties

ActiveTab

Declaration

public TabInfo ActiveTab { get; set; }

Property Value

Type	Description
TabInfo

AddCachebusterToResourceUris

Declaration

public bool AddCachebusterToResourceUris { get; }

Property Value

Type	Description
bool

AddCompatibleHttpHeader

Declaration

public string AddCompatibleHttpHeader { get; }

Property Value

Type	Description
string

AdminTabId

Declaration

public int AdminTabId { get; set; }

Property Value

Type	Description
int

AdministratorId

Declaration

public int AdministratorId { get; set; }

Property Value

Type	Description
int

AdministratorRoleId

Declaration

public int AdministratorRoleId { get; set; }

Property Value

Type	Description
int

AdministratorRoleName

Declaration

public string AdministratorRoleName { get; set; }

Property Value

Type	Description
string

AllowUserUICulture

Declaration

public bool AllowUserUICulture { get; }

Property Value

Type	Description
bool

AllowedExtensionsWhitelist

Declaration

public FileExtensionWhitelist AllowedExtensionsWhitelist { get; }

Property Value

Type	Description
FileExtensionWhitelist

BackgroundFile

Declaration

public string BackgroundFile { get; set; }

Property Value

Type	Description
string

BannerAdvertising

Declaration

public int BannerAdvertising { get; set; }

Property Value

Type	Description
int

Cacheability

Declaration

public CacheLevel Cacheability { get; }

Property Value

Type	Description
CacheLevel

CdfVersion

Declaration

public int CdfVersion { get; }

Property Value

Type	Description
int

ContentLocalizationEnabled

Declaration

public bool ContentLocalizationEnabled { get; }

Property Value

Type	Description
bool

ControlPanelSecurity

Declaration

public PortalSettings.ControlPanelPermission ControlPanelSecurity { get; }

Property Value

Type	Description
PortalSettings.ControlPanelPermission

ControlPanelVisible

Declaration

public bool ControlPanelVisible { get; }

Property Value

Type	Description
bool

CookieMoreLink

Declaration

public string CookieMoreLink { get; }

Property Value

Type	Description
string

CultureCode

Declaration

public string CultureCode { get; set; }

Property Value

Type	Description
string

Currency

Declaration

public string Currency { get; set; }

Property Value

Type	Description
string

Current

Declaration

public static PortalSettings Current { get; }

Property Value

Type	Description
PortalSettings

DataConsentActive

Declaration

public bool DataConsentActive { get; }

Property Value

Type	Description
bool

DataConsentConsentRedirect

Declaration

public int DataConsentConsentRedirect { get; }

Property Value

Type	Description
int

DataConsentDelay

Declaration

public int DataConsentDelay { get; }

Property Value

Type	Description
int

DataConsentDelayMeasurement

Declaration

public string DataConsentDelayMeasurement { get; }

Property Value

Type	Description
string

DataConsentTermsLastChange

Declaration

public DateTime DataConsentTermsLastChange { get; }

Property Value

Type	Description
DateTime

DataConsentUserDeleteAction

Declaration

public PortalSettings.UserDeleteAction DataConsentUserDeleteAction { get; }

Property Value

Type	Description
PortalSettings.UserDeleteAction

DefaultAdminContainer

Declaration

public string DefaultAdminContainer { get; }

Property Value

Type	Description
string

DefaultAdminSkin

Declaration

public string DefaultAdminSkin { get; }

Property Value

Type	Description
string

DefaultAuthProvider

Declaration

public string DefaultAuthProvider { get; }

Property Value

Type	Description
string

DefaultControlPanelMode

Declaration

public PortalSettings.Mode DefaultControlPanelMode { get; }

Property Value

Type	Description
PortalSettings.Mode

DefaultControlPanelVisibility

Declaration

public bool DefaultControlPanelVisibility { get; }

Property Value

Type	Description
bool

DefaultIconLocation

Declaration

public string DefaultIconLocation { get; }

Property Value

Type	Description
string

DefaultLanguage

Declaration

public string DefaultLanguage { get; set; }

Property Value

Type	Description
string

DefaultModuleActionMenu

Declaration

public string DefaultModuleActionMenu { get; }

Property Value

Type	Description
string

DefaultModuleId

Declaration

public int DefaultModuleId { get; }

Property Value

Type	Description
int

DefaultPortalAlias

Declaration

public string DefaultPortalAlias { get; }

Property Value

Type	Description
string

DefaultPortalContainer

Declaration

public string DefaultPortalContainer { get; }

Property Value

Type	Description
string

DefaultPortalSkin

Declaration

public string DefaultPortalSkin { get; }

Property Value

Type	Description
string

DefaultTabId

Declaration

public int DefaultTabId { get; }

Property Value

Type	Description
int

Description

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

DisablePrivateMessage

Declaration

public bool DisablePrivateMessage { get; }

Property Value

Type	Description
bool

Email

Declaration

public string Email { get; set; }

Property Value

Type	Description
string

EnableBrowserLanguage

Declaration

public bool EnableBrowserLanguage { get; }

Property Value

Type	Description
bool

EnableCompositeFiles

Declaration

public bool EnableCompositeFiles { get; }

Property Value

Type	Description
bool

EnablePopUps

Declaration

public bool EnablePopUps { get; }

Property Value

Type	Description
bool

EnableRegisterNotification

Declaration

public bool EnableRegisterNotification { get; }

Property Value

Type	Description
bool

EnableSkinWidgets

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.1. This setting is no longer relevant as skin widgets are no longer supported. Scheduled removal in v11.0.0.")]
public bool EnableSkinWidgets { get; }

Property Value

Type	Description
bool

EnableUnapprovedPasswordReminderNotification

Declaration

public bool EnableUnapprovedPasswordReminderNotification { get; }

Property Value

Type	Description
bool

EnableUrlLanguage

Declaration

public bool EnableUrlLanguage { get; }

Property Value

Type	Description
bool

ErrorPage404

Declaration

public int ErrorPage404 { get; }

Property Value

Type	Description
int

ErrorPage500

Declaration

public int ErrorPage500 { get; }

Property Value

Type	Description
int

ExpiryDate

Declaration

public DateTime ExpiryDate { get; set; }

Property Value

Type	Description
DateTime

FooterText

Declaration

public string FooterText { get; set; }

Property Value

Type	Description
string

GUID

Declaration

public Guid GUID { get; set; }

Property Value

Type	Description
Guid

HideFoldersEnabled

Declaration

public bool HideFoldersEnabled { get; }

Property Value

Type	Description
bool

HideLoginControl

Declaration

public bool HideLoginControl { get; }

Property Value

Type	Description
bool

HomeDirectory

Declaration

public string HomeDirectory { get; set; }

Property Value

Type	Description
string

HomeDirectoryMapPath

Declaration

public string HomeDirectoryMapPath { get; }

Property Value

Type	Description
string

HomeSystemDirectory

Declaration

public string HomeSystemDirectory { get; set; }

Property Value

Type	Description
string

HomeSystemDirectoryMapPath

Declaration

public string HomeSystemDirectoryMapPath { get; }

Property Value

Type	Description
string

HomeTabId

Declaration

public int HomeTabId { get; set; }

Property Value

Type	Description
int

HostFee

Declaration

public float HostFee { get; set; }

Property Value

Type	Description
float

HostSpace

Declaration

public int HostSpace { get; set; }

Property Value

Type	Description
int

InjectModuleHyperLink

Declaration

public bool InjectModuleHyperLink { get; }

Property Value

Type	Description
bool

InlineEditorEnabled

Declaration

public bool InlineEditorEnabled { get; }

Property Value

Type	Description
bool

IsLocked

Declaration

public bool IsLocked { get; }

Property Value

Type	Description
bool

IsThisPortalLocked

Declaration

public bool IsThisPortalLocked { get; }

Property Value

Type	Description
bool

KeyWords

Declaration

public string KeyWords { get; set; }

Property Value

Type	Description
string

LoginTabId

Declaration

public int LoginTabId { get; set; }

Property Value

Type	Description
int

LogoFile

Declaration

public string LogoFile { get; set; }

Property Value

Type	Description
string

PageHeadText

Declaration

public string PageHeadText { get; }

Property Value

Type	Description
string

PageQuota

Declaration

public int PageQuota { get; set; }

Property Value

Type	Description
int

Pages

Declaration

public int Pages { get; set; }

Property Value

Type	Description
int

PortalAlias

Declaration

public PortalAliasInfo PortalAlias { get; set; }

Property Value

Type	Description
PortalAliasInfo

PortalAliasMappingMode

Declaration

public PortalSettings.PortalAliasMapping PortalAliasMappingMode { get; }

Property Value

Type	Description
PortalSettings.PortalAliasMapping

PortalId

Declaration

public int PortalId { get; set; }

Property Value

Type	Description
int

PortalName

Declaration

public string PortalName { get; set; }

Property Value

Type	Description
string

PrimaryAlias

Declaration

public PortalAliasInfo PrimaryAlias { get; set; }

Property Value

Type	Description
PortalAliasInfo

PrivacyTabId

Declaration

public int PrivacyTabId { get; set; }

Property Value

Type	Description
int

RegisterTabId

Declaration

public int RegisterTabId { get; set; }

Property Value

Type	Description
int

RegisteredRoleId

Declaration

public int RegisteredRoleId { get; set; }

Property Value

Type	Description
int

RegisteredRoleName

Declaration

public string RegisteredRoleName { get; set; }

Property Value

Type	Description
string

Registration

Declaration

public RegistrationSettings Registration { get; set; }

Property Value

Type	Description
RegistrationSettings

SMTPConnectionLimit

Declaration

public int SMTPConnectionLimit { get; }

Property Value

Type	Description
int

SMTPMaxIdleTime

Declaration

public int SMTPMaxIdleTime { get; }

Property Value

Type	Description
int

SSLEnabled

Declaration

public bool SSLEnabled { get; }

Property Value

Type	Description
bool

SSLEnforced

Declaration

public bool SSLEnforced { get; }

Property Value

Type	Description
bool

SSLSetup

Declaration

public SiteSslSetup SSLSetup { get; }

Property Value

Type	Description
SiteSslSetup

SSLURL

Declaration

public string SSLURL { get; }

Property Value

Type	Description
string

STDURL

Declaration

public string STDURL { get; }

Property Value

Type	Description
string

SearchIncludeCommon

Declaration

public bool SearchIncludeCommon { get; }

Property Value

Type	Description
bool

SearchIncludeNumeric

Declaration

public bool SearchIncludeNumeric { get; }

Property Value

Type	Description
bool

SearchIncludedTagInfoFilter

Declaration

public string SearchIncludedTagInfoFilter { get; }

Property Value

Type	Description
string

SearchMaxWordlLength

Declaration

public int SearchMaxWordlLength { get; }

Property Value

Type	Description
int

SearchMinWordlLength

Declaration

public int SearchMinWordlLength { get; }

Property Value

Type	Description
int

SearchTabId

Declaration

public int SearchTabId { get; set; }

Property Value

Type	Description
int

ShowCookieConsent

Declaration

public bool ShowCookieConsent { get; }

Property Value

Type	Description
bool

ShowQuickModuleAddMenu

Declaration

public bool ShowQuickModuleAddMenu { get; }

Property Value

Type	Description
bool

SplashTabId

Declaration

public int SplashTabId { get; set; }

Property Value

Type	Description
int

SuperTabId

Declaration

public int SuperTabId { get; set; }

Property Value

Type	Description
int

TermsTabId

Declaration

public int TermsTabId { get; set; }

Property Value

Type	Description
int

TimeZone

Declaration

public TimeZoneInfo TimeZone { get; set; }

Property Value

Type	Description
TimeZoneInfo

UserId

Declaration

public int UserId { get; }

Property Value

Type	Description
int

UserInfo

Declaration

public UserInfo UserInfo { get; }

Property Value

Type	Description
UserInfo

UserMode

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.1. Use Personalization.GetUserMode() instead. Scheduled removal in v11.0.0.")]
public PortalSettings.Mode UserMode { get; }

Property Value

Type	Description
PortalSettings.Mode

UserQuota

Declaration

public int UserQuota { get; set; }

Property Value

Type	Description
int

UserRegistration

Declaration

public int UserRegistration { get; set; }

Property Value

Type	Description
int

UserTabId

Declaration

public int UserTabId { get; set; }

Property Value

Type	Description
int

Users

Declaration

public int Users { get; set; }

Property Value

Type	Description
int

Methods

Clone()

Declaration

public PortalSettings Clone()

Returns

Type	Description
PortalSettings

GetProperty(string, string, CultureInfo, UserInfo, Scope, ref bool)

Declaration

public string GetProperty(string propertyName, string format, CultureInfo formatProvider, UserInfo accessingUser, Scope accessLevel, ref bool propertyNotFound)

Parameters

Type	Name	Description
string	propertyName
string	format
CultureInfo	formatProvider
UserInfo	accessingUser
Scope	accessLevel
bool	propertyNotFound

Returns

Type	Description
string

Implements

IPropertyAccess

IPortalSettings

Extension Methods

PortalSettingsExtensions.InErrorPageRequest(PortalSettings)

JsonExtensionsWeb.ToJson(object)