Class PortalSettings

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Inheritance

System.Object

BaseEntityInfo

PortalSettings

Implements

IPropertyAccess

IPortalSettings

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.Portals

Assembly: DotNetNuke.dll

Syntax

public class PortalSettings : BaseEntityInfo, IPropertyAccess, IPortalSettings

Constructors

PortalSettings()

Initializes a new instance of the PortalSettings class.

Declaration

public PortalSettings()

PortalSettings(PortalInfo)

Initializes a new instance of the PortalSettings class.

Declaration

public PortalSettings(PortalInfo portal)

Parameters

Type	Name	Description
PortalInfo	portal

PortalSettings(Int32, PortalAliasInfo)

Initializes a new instance of the PortalSettings class. The PortalSettings Constructor encapsulates all of the logic necessary to obtain configuration settings necessary to render a Portal Tab view for a given request.

Declaration

public PortalSettings(int tabId, PortalAliasInfo portalAliasInfo)

Parameters

Type	Name	Description
System.Int32	tabId	The current tab.
PortalAliasInfo	portalAliasInfo	The current portal.

PortalSettings(Int32, PortalInfo)

Initializes a new instance of the PortalSettings class.

Declaration

public PortalSettings(int tabId, PortalInfo portal)

Parameters

Type	Name	Description
System.Int32	tabId
PortalInfo	portal

PortalSettings(Int32, Int32)

Initializes a new instance of the PortalSettings class.

Declaration

public PortalSettings(int tabId, int portalId)

Parameters

Type	Name	Description
System.Int32	tabId
System.Int32	portalId

PortalSettings(Int32)

Initializes a new instance of the PortalSettings class.

Declaration

public PortalSettings(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Properties

ActiveTab

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public TabInfo ActiveTab { get; set; }

Property Value

Type	Description
TabInfo

AddCachebusterToResourceUris

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool AddCachebusterToResourceUris { get; }

Property Value

Type	Description
System.Boolean

AddCompatibleHttpHeader

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string AddCompatibleHttpHeader { get; }

Property Value

Type	Description
System.String

AdministratorId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int AdministratorId { get; set; }

Property Value

Type	Description
System.Int32

AdministratorRoleId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int AdministratorRoleId { get; set; }

Property Value

Type	Description
System.Int32

AdministratorRoleName

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string AdministratorRoleName { get; set; }

Property Value

Type	Description
System.String

AdminTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int AdminTabId { get; set; }

Property Value

Type	Description
System.Int32

AllowedExtensionsWhitelist

Gets whitelist of file extensions for end users.

Declaration

public FileExtensionWhitelist AllowedExtensionsWhitelist { get; }

Property Value

Type	Description
FileExtensionWhitelist

AllowUserUICulture

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool AllowUserUICulture { get; }

Property Value

Type	Description
System.Boolean

BackgroundFile

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string BackgroundFile { get; set; }

Property Value

Type	Description
System.String

BannerAdvertising

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int BannerAdvertising { get; set; }

Property Value

Type	Description
System.Int32

Cacheability

Gets the cache level for property access.

Declaration

public CacheLevel Cacheability { get; }

Property Value

Type	Description
CacheLevel

CdfVersion

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int CdfVersion { get; }

Property Value

Type	Description
System.Int32

ContentLocalizationEnabled

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool ContentLocalizationEnabled { get; }

Property Value

Type	Description
System.Boolean

ControlPanelSecurity

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public PortalSettings.ControlPanelPermission ControlPanelSecurity { get; }

Property Value

Type	Description
PortalSettings.ControlPanelPermission

ControlPanelVisible

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool ControlPanelVisible { get; }

Property Value

Type	Description
System.Boolean

CookieMoreLink

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string CookieMoreLink { get; }

Property Value

Type	Description
System.String

CultureCode

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string CultureCode { get; set; }

Property Value

Type	Description
System.String

Currency

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string Currency { get; set; }

Property Value

Type	Description
System.String

Current

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public static PortalSettings Current { get; }

Property Value

Type	Description
PortalSettings

DataConsentActive

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool DataConsentActive { get; }

Property Value

Type	Description
System.Boolean

DataConsentConsentRedirect

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int DataConsentConsentRedirect { get; }

Property Value

Type	Description
System.Int32

DataConsentDelay

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int DataConsentDelay { get; }

Property Value

Type	Description
System.Int32

DataConsentDelayMeasurement

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DataConsentDelayMeasurement { get; }

Property Value

Type	Description
System.String

DataConsentTermsLastChange

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public DateTime DataConsentTermsLastChange { get; }

Property Value

Type	Description
DateTime

DataConsentUserDeleteAction

Gets what should happen to the user account if a user has been deleted. This is important as under certain circumstances you may be required by law to destroy the user's data within a certain timeframe after a user has requested deletion.

Declaration

public PortalSettings.UserDeleteAction DataConsentUserDeleteAction { get; }

Property Value

Type	Description
PortalSettings.UserDeleteAction

DefaultAdminContainer

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultAdminContainer { get; }

Property Value

Type	Description
System.String

DefaultAdminSkin

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultAdminSkin { get; }

Property Value

Type	Description
System.String

DefaultAuthProvider

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultAuthProvider { get; }

Property Value

Type	Description
System.String

DefaultControlPanelMode

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public PortalSettings.Mode DefaultControlPanelMode { get; }

Property Value

Type	Description
PortalSettings.Mode

DefaultControlPanelVisibility

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool DefaultControlPanelVisibility { get; }

Property Value

Type	Description
System.Boolean

DefaultIconLocation

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultIconLocation { get; }

Property Value

Type	Description
System.String

DefaultLanguage

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultLanguage { get; set; }

Property Value

Type	Description
System.String

DefaultModuleActionMenu

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultModuleActionMenu { get; }

Property Value

Type	Description
System.String

DefaultModuleId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int DefaultModuleId { get; }

Property Value

Type	Description
System.Int32

DefaultPortalAlias

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultPortalAlias { get; }

Property Value

Type	Description
System.String

DefaultPortalContainer

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultPortalContainer { get; }

Property Value

Type	Description
System.String

DefaultPortalSkin

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string DefaultPortalSkin { get; }

Property Value

Type	Description
System.String

DefaultTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int DefaultTabId { get; }

Property Value

Type	Description
System.Int32

Description

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DisablePrivateMessage

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool DisablePrivateMessage { get; }

Property Value

Type	Description
System.Boolean

Email

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string Email { get; set; }

Property Value

Type	Description
System.String

EnableBrowserLanguage

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool EnableBrowserLanguage { get; }

Property Value

Type	Description
System.Boolean

EnableCompositeFiles

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool EnableCompositeFiles { get; }

Property Value

Type	Description
System.Boolean

EnableModuleEffect

Gets a value indicating whether gets whether to use the module effect in edit mode.

Declaration

public bool EnableModuleEffect { get; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to True.

EnablePopUps

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool EnablePopUps { get; }

Property Value

Type	Description
System.Boolean

EnableRegisterNotification

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool EnableRegisterNotification { get; }

Property Value

Type	Description
System.Boolean

EnableSkinWidgets

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool EnableSkinWidgets { get; }

Property Value

Type	Description
System.Boolean

EnableUrlLanguage

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool EnableUrlLanguage { get; }

Property Value

Type	Description
System.Boolean

ErrorPage404

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int ErrorPage404 { get; }

Property Value

Type	Description
System.Int32

ErrorPage500

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int ErrorPage500 { get; }

Property Value

Type	Description
System.Int32

ExpiryDate

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public DateTime ExpiryDate { get; set; }

Property Value

Type	Description
DateTime

FooterText

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string FooterText { get; set; }

Property Value

Type	Description
System.String

GUID

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public Guid GUID { get; set; }

Property Value

Type	Description
Guid

HideFoldersEnabled

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool HideFoldersEnabled { get; }

Property Value

Type	Description
System.Boolean

HideLoginControl

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool HideLoginControl { get; }

Property Value

Type	Description
System.Boolean

HomeDirectory

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string HomeDirectory { get; set; }

Property Value

Type	Description
System.String

HomeDirectoryMapPath

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string HomeDirectoryMapPath { get; }

Property Value

Type	Description
System.String

HomeSystemDirectory

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string HomeSystemDirectory { get; set; }

Property Value

Type	Description
System.String

HomeSystemDirectoryMapPath

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string HomeSystemDirectoryMapPath { get; }

Property Value

Type	Description
System.String

HomeTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int HomeTabId { get; set; }

Property Value

Type	Description
System.Int32

HostFee

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public float HostFee { get; set; }

Property Value

Type	Description
System.Single

HostSpace

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int HostSpace { get; set; }

Property Value

Type	Description
System.Int32

InjectModuleHyperLink

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool InjectModuleHyperLink { get; }

Property Value

Type	Description
System.Boolean

InlineEditorEnabled

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool InlineEditorEnabled { get; }

Property Value

Type	Description
System.Boolean

IsLocked

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool IsLocked { get; }

Property Value

Type	Description
System.Boolean

IsThisPortalLocked

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool IsThisPortalLocked { get; }

Property Value

Type	Description
System.Boolean

KeyWords

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string KeyWords { get; set; }

Property Value

Type	Description
System.String

LoginTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int LoginTabId { get; set; }

Property Value

Type	Description
System.Int32

LogoFile

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string LogoFile { get; set; }

Property Value

Type	Description
System.String

PageHeadText

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string PageHeadText { get; }

Property Value

Type	Description
System.String

PageQuota

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int PageQuota { get; set; }

Property Value

Type	Description
System.Int32

Pages

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int Pages { get; set; }

Property Value

Type	Description
System.Int32

PortalAlias

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public PortalAliasInfo PortalAlias { get; set; }

Property Value

Type	Description
PortalAliasInfo

PortalAliasMappingMode

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public PortalSettings.PortalAliasMapping PortalAliasMappingMode { get; }

Property Value

Type	Description
PortalSettings.PortalAliasMapping

PortalId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int PortalId { get; set; }

Property Value

Type	Description
System.Int32

PortalName

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string PortalName { get; set; }

Property Value

Type	Description
System.String

PrimaryAlias

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public PortalAliasInfo PrimaryAlias { get; set; }

Property Value

Type	Description
PortalAliasInfo

PrivacyTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int PrivacyTabId { get; set; }

Property Value

Type	Description
System.Int32

RegisteredRoleId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int RegisteredRoleId { get; set; }

Property Value

Type	Description
System.Int32

RegisteredRoleName

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string RegisteredRoleName { get; set; }

Property Value

Type	Description
System.String

RegisterTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int RegisterTabId { get; set; }

Property Value

Type	Description
System.Int32

Registration

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public RegistrationSettings Registration { get; set; }

Property Value

Type	Description
RegistrationSettings

SearchIncludeCommon

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool SearchIncludeCommon { get; }

Property Value

Type	Description
System.Boolean

SearchIncludedTagInfoFilter

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string SearchIncludedTagInfoFilter { get; }

Property Value

Type	Description
System.String

SearchIncludeNumeric

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool SearchIncludeNumeric { get; }

Property Value

Type	Description
System.Boolean

SearchMaxWordlLength

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SearchMaxWordlLength { get; }

Property Value

Type	Description
System.Int32

SearchMinWordlLength

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SearchMinWordlLength { get; }

Property Value

Type	Description
System.Int32

SearchTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SearchTabId { get; set; }

Property Value

Type	Description
System.Int32

ShowCookieConsent

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool ShowCookieConsent { get; }

Property Value

Type	Description
System.Boolean

ShowQuickModuleAddMenu

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool ShowQuickModuleAddMenu { get; }

Property Value

Type	Description
System.Boolean

SiteLogHistory

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SiteLogHistory { get; set; }

Property Value

Type	Description
System.Int32

SMTPConnectionLimit

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SMTPConnectionLimit { get; }

Property Value

Type	Description
System.Int32

SMTPMaxIdleTime

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SMTPMaxIdleTime { get; }

Property Value

Type	Description
System.Int32

SplashTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SplashTabId { get; set; }

Property Value

Type	Description
System.Int32

SSLEnabled

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool SSLEnabled { get; }

Property Value

Type	Description
System.Boolean

SSLEnforced

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public bool SSLEnforced { get; }

Property Value

Type	Description
System.Boolean

SSLSetup

Gets a value indicating what the SSL setup is for this portal.

Declaration

public SiteSslSetup SSLSetup { get; }

Property Value

Type	Description
SiteSslSetup

SSLURL

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string SSLURL { get; }

Property Value

Type	Description
System.String

STDURL

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public string STDURL { get; }

Property Value

Type	Description
System.String

SuperTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int SuperTabId { get; set; }

Property Value

Type	Description
System.Int32

TermsTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int TermsTabId { get; set; }

Property Value

Type	Description
System.Int32

TimeZone

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public TimeZoneInfo TimeZone { get; set; }

Property Value

Type	Description
TimeZoneInfo

UserId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int UserId { get; }

Property Value

Type	Description
System.Int32

UserInfo

Gets the currently logged in user.

Declaration

public UserInfo UserInfo { get; }

Property Value

Type	Description
UserInfo	The current user information.

UserMode

Gets the mode the user is viewing the page in.

Declaration

public PortalSettings.Mode UserMode { get; }

Property Value

Type	Description
PortalSettings.Mode

UserQuota

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int UserQuota { get; set; }

Property Value

Type	Description
System.Int32

UserRegistration

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int UserRegistration { get; set; }

Property Value

Type	Description
System.Int32

Users

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int Users { get; set; }

Property Value

Type	Description
System.Int32

UserTabId

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public int UserTabId { get; set; }

Property Value

Type	Description
System.Int32

Methods

Clone()

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public PortalSettings Clone()

Returns

Type	Description
PortalSettings

GetPortalAliasMappingMode(Int32)

The PortalSettings class encapsulates all of the settings for the Portal, as well as the configuration settings required to execute the current tab view within the portal.

Declaration

public static PortalSettings.PortalAliasMapping GetPortalAliasMappingMode(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
PortalSettings.PortalAliasMapping

GetProperty(String, String, CultureInfo, UserInfo, Scope, ref Boolean)

Gets a property.

Declaration

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

Parameters

Type	Name	Description
System.String	propertyName	The property name to get.
System.String	format	The format string to format the property with, or null to use the default format.
CultureInfo	formatProvider	The format provider (e.g. ) to use.
UserInfo	accessingUser	The user this property belongs to, UserInfo.
Scope	accessLevel	The Scope of the access level for this property.
System.Boolean	propertyNotFound	An out parameter that indicates if the property was not found.

Returns

Type	Description
System.String	A string with the value of the property.

Implements

IPropertyAccess

IPortalSettings

Extension Methods

PortalSettingsExtensions.InErrorPageRequest(PortalSettings)

JsonExtensionsWeb.ToJson(Object)