Interface IPortalSettings

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.

Namespace: DotNetNuke.Abstractions.Portals
Assembly: DotNetNuke.Abstractions.dll
Syntax
public interface IPortalSettings

Properties

| Improve this Doc View Source

AddCachebusterToResourceUris

Gets a value indicating whether if true then add a cachebuster parameter to generated file URI's.

Declaration
bool AddCachebusterToResourceUris { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

AddCompatibleHttpHeader

Gets a compatible page header.

Declaration
string AddCompatibleHttpHeader { get; }
Property Value
Type Description
System.String
Remarks

generates a : Page.Response.AddHeader("X-UA-Compatible", "").

| Improve this Doc View Source

AdministratorId

Gets or sets the administrator id.

Declaration
int AdministratorId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

AdministratorRoleId

Gets or sets the administrator role id.

Declaration
int AdministratorRoleId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

AdministratorRoleName

Gets or sets the administrator role name.

Declaration
string AdministratorRoleName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

AdminTabId

Gets or sets the admin tab id.

Declaration
int AdminTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

AllowUserUICulture

Gets a value indicating whether allows users to select their own UI culture. When set to false (default) framework will allways same culture for both CurrentCulture (content) and CurrentUICulture (interface).

Declaration
bool AllowUserUICulture { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to False.

| Improve this Doc View Source

BackgroundFile

Gets or sets the background file.

Declaration
string BackgroundFile { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

BannerAdvertising

Gets or sets the banner advertising.

Declaration
int BannerAdvertising { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

CdfVersion

Gets the CDF version.

Declaration
int CdfVersion { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ContentLocalizationEnabled

Gets a value indicating whether the content is localized.

Declaration
bool ContentLocalizationEnabled { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ControlPanelVisible

Gets a value indicating whether the control panel is visible.

Declaration
bool ControlPanelVisible { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Gets link for the user to find out more about cookies. If not specified the link shown will point to cookiesandyou.com.

Declaration
string CookieMoreLink { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CultureCode

Gets or sets the culture code.

Declaration
string CultureCode { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Currency

Gets or sets the currency.

Declaration
string Currency { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DataConsentActive

Gets a value indicating whether if true then all users will be pushed through the data consent workflow.

Declaration
bool DataConsentActive { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DataConsentConsentRedirect

Gets if set this is a tab id of a page where the user will be redirected to for consent. If not set then the platform's default logic is used.

Declaration
int DataConsentConsentRedirect { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DataConsentDelay

Gets the delay time (in conjunction with DataConsentDelayMeasurement) for the DataConsentUserDeleteAction.

Declaration
int DataConsentDelay { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DataConsentDelayMeasurement

Gets units for DataConsentDelay.

Declaration
string DataConsentDelayMeasurement { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DataConsentTermsLastChange

Gets last time the terms and conditions have been changed. This will determine if the user needs to reconsent or not. Legally once the terms have changed, users need to sign again. This value is set by the "reset consent" button on the UI.

Declaration
DateTime DataConsentTermsLastChange { get; }
Property Value
Type Description
DateTime
| Improve this Doc View Source

DefaultAdminContainer

Gets the default admin container.

Declaration
string DefaultAdminContainer { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultAdminSkin

Gets the default admin skin.

Declaration
string DefaultAdminSkin { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultAuthProvider

Gets the default authentication provider.

Declaration
string DefaultAuthProvider { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultControlPanelVisibility

Gets a value indicating whether the default control panel is visible.

Declaration
bool DefaultControlPanelVisibility { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultIconLocation

Gets the default icon location.

Declaration
string DefaultIconLocation { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultLanguage

Gets or sets the default location.

Declaration
string DefaultLanguage { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultModuleActionMenu

Gets the default module action menu.

Declaration
string DefaultModuleActionMenu { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultModuleId

Gets the Default Module Id.

Declaration
int DefaultModuleId { get; }
Property Value
Type Description
System.Int32
Remarks

Defaults to Null.NullInteger.

| Improve this Doc View Source

DefaultPortalAlias

Gets the default portal alias.

Declaration
string DefaultPortalAlias { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultPortalContainer

Gets the default portal container.

Declaration
string DefaultPortalContainer { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultPortalSkin

Gets the default portal skin.

Declaration
string DefaultPortalSkin { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DefaultTabId

Gets the Default Tab Id.

Declaration
int DefaultTabId { get; }
Property Value
Type Description
System.Int32
Remarks

Defaults to Null.NullInteger.

| Improve this Doc View Source

Description

Gets or sets the portal description.

Declaration
string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DisablePrivateMessage

Gets a value indicating whether if this is true, then regular users can't send message to specific user/group.

Declaration
bool DisablePrivateMessage { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Email

Gets or sets the portal email.

Declaration
string Email { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

EnableBrowserLanguage

Gets a value indicating whether Browser Language Detection is Enabled.

Declaration
bool EnableBrowserLanguage { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to True.

| Improve this Doc View Source

EnableCompositeFiles

Gets a value indicating whether the composite files for client scripts is enabled.

Declaration
bool EnableCompositeFiles { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

EnablePopUps

Gets a value indicating whether to use the popup.

Declaration
bool EnablePopUps { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to True.

| Improve this Doc View Source

EnableRegisterNotification

Gets a value indicating whether website Administrator whether receive the notification email when new user register.

Declaration
bool EnableRegisterNotification { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

EnableSkinWidgets

Gets a value indicating whether the Skin Widgets are enabled/supported.

Declaration
bool EnableSkinWidgets { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to True.

| Improve this Doc View Source

EnableUrlLanguage

Gets a value indicating whether enable url language.

Declaration
bool EnableUrlLanguage { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to True.

| Improve this Doc View Source

ErrorPage404

Gets the error page 404.

Declaration
int ErrorPage404 { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ErrorPage500

Gets the error page 500.

Declaration
int ErrorPage500 { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ExpiryDate

Gets or sets the expiry date.

Declaration
DateTime ExpiryDate { get; set; }
Property Value
Type Description
DateTime
| Improve this Doc View Source

FooterText

Gets or sets the portal footer text.

Declaration
string FooterText { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

GUID

Gets or sets the portal GUID.

Declaration
Guid GUID { get; set; }
Property Value
Type Description
Guid
| Improve this Doc View Source

HideFoldersEnabled

Gets a value indicating whether gets whether folders which are hidden or whose name begins with underscore are included in folder synchronization.

Declaration
bool HideFoldersEnabled { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to True.

| Improve this Doc View Source

HideLoginControl

Gets a value indicating whether hide the login link.

Declaration
bool HideLoginControl { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to False.

| Improve this Doc View Source

HomeDirectory

Gets or sets the portal home directory.

Declaration
string HomeDirectory { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

HomeDirectoryMapPath

Gets the portals home directory mapped path.

Declaration
string HomeDirectoryMapPath { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

HomeSystemDirectory

Gets or sets the portals home system directory.

Declaration
string HomeSystemDirectory { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

HomeSystemDirectoryMapPath

Gets the portals home directory mapped path.

Declaration
string HomeSystemDirectoryMapPath { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

HomeTabId

Gets or sets the portals home tab id.

Declaration
int HomeTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

HostFee

Gets or sets the host fee.

Declaration
float HostFee { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

HostSpace

Gets or sets the host space.

Declaration
int HostSpace { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Gets a value indicating whether a module can inject a hyperlink.

Declaration
bool InjectModuleHyperLink { get; }
Property Value
Type Description
System.Boolean

add <a name="[moduleid]"></a> on the top of the module. Desactivate this remove the html5 compatibility warnings (and make the output smaller).

| Improve this Doc View Source

InlineEditorEnabled

Gets a value indicating whether the Inline Editor is enabled.

Declaration
bool InlineEditorEnabled { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to True.

| Improve this Doc View Source

IsLocked

Gets a value indicating whether get a value indicating whether the current portal is in maintenance mode (if either this specific portal or the entire instance is locked). If locked, any actions which update the database should be disabled.

Declaration
bool IsLocked { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsThisPortalLocked

Gets a value indicating whether get a value indicating whether the current portal is in maintenance mode (note, the entire instance may still be locked, this only indicates whether this portal is specifically locked). If locked, any actions which update the database should be disabled.

Declaration
bool IsThisPortalLocked { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

KeyWords

Gets or sets the portal keywords.

Declaration
string KeyWords { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LoginTabId

Gets or sets the portals login tab id.

Declaration
int LoginTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

LogoFile

Gets or sets the portals logo file.

Declaration
string LogoFile { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PageHeadText

Gets the portals page head text.

Declaration
string PageHeadText { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PageQuota

Gets or sets the portals page quota.

Declaration
int PageQuota { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Pages

Gets or sets the portals pages.

Declaration
int Pages { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PortalId

Gets or sets the portal id.

Declaration
int PortalId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PortalName

Gets or sets the portal name.

Declaration
string PortalName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PrivacyTabId

Gets or sets the portals privacy tab id.

Declaration
int PrivacyTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RegisteredRoleId

Gets or sets the portals registered role id.

Declaration
int RegisteredRoleId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RegisteredRoleName

Gets or sets the portals registered role name.

Declaration
string RegisteredRoleName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RegisterTabId

Gets or sets the portals register tab id.

Declaration
int RegisterTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SearchIncludeCommon

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

Declaration
bool SearchIncludeCommon { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to False.

| Improve this Doc View Source

SearchIncludedTagInfoFilter

Gets the filter used for inclusion of tag info.

Declaration
string SearchIncludedTagInfoFilter { get; }
Property Value
Type Description
System.String
Remarks

Defaults to "".

| Improve this Doc View Source

SearchIncludeNumeric

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

Declaration
bool SearchIncludeNumeric { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to False.

| Improve this Doc View Source

SearchMaxWordlLength

Gets the maximum Search Word length to index.

Declaration
int SearchMaxWordlLength { get; }
Property Value
Type Description
System.Int32
Remarks

Defaults to 3.

| Improve this Doc View Source

SearchMinWordlLength

Gets the minimum Search Word length to index.

Declaration
int SearchMinWordlLength { get; }
Property Value
Type Description
System.Int32
Remarks

Defaults to 3.

| Improve this Doc View Source

SearchTabId

Gets or sets the portals search tab id.

Declaration
int SearchTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ShowCookieConsent

Gets a value indicating whether a cookie consent popup should be shown.

Declaration
bool ShowCookieConsent { get; }
Property Value
Type Description
System.Boolean
Remarks

Defaults to False.

| Improve this Doc View Source

ShowQuickModuleAddMenu

Gets a value indicating whether to display the dropdowns to quickly add a moduel to the page in the edit bar.

Declaration
bool ShowQuickModuleAddMenu { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SMTPConnectionLimit

Gets the portals SMTP connection limit.

Declaration
int SMTPConnectionLimit { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SMTPMaxIdleTime

Gets the portals SMPT max idle time.

Declaration
int SMTPMaxIdleTime { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SplashTabId

Gets or sets the portals splash tab id.

Declaration
int SplashTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SSLEnabled

Gets a value indicating whether SSL is enabled for the portal.

Declaration
bool SSLEnabled { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SSLEnforced

Gets a value indicating whether SLL is enforced for the portal.

Declaration
bool SSLEnforced { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SSLSetup

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

Declaration
SiteSslSetup SSLSetup { get; }
Property Value
Type Description
SiteSslSetup
| Improve this Doc View Source

SSLURL

Gets the SSL url for the portal.

Declaration
string SSLURL { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

STDURL

Gets the standard url for the portal.

Declaration
string STDURL { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SuperTabId

Gets or sets the super tab id.

Declaration
int SuperTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TermsTabId

Gets or sets the terms and conditions tab id.

Declaration
int TermsTabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TimeZone

Gets or sets the timezone for the portal.

Declaration
TimeZoneInfo TimeZone { get; set; }
Property Value
Type Description
TimeZoneInfo
| Improve this Doc View Source

UserId

Gets the currently logged in user identifier.

Declaration
int UserId { get; }
Property Value
Type Description
System.Int32

The user identifier.
| Improve this Doc View Source

UserQuota

Gets or sets the user quota for the portal.

Declaration
int UserQuota { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

UserRegistration

Gets or sets the user registration for the portal.

Declaration
int UserRegistration { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Users

Gets or sets the users for the portal.

Declaration
int Users { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

UserTabId

Gets or sets the user tab id for the portal.

Declaration
int UserTabId { get; set; }
Property Value
Type Description
System.Int32

Extension Methods