Interface IPortalInfo

The portal info.

Namespace: DotNetNuke.Abstractions.Portals

Assembly: DotNetNuke.Abstractions.dll

Syntax

public interface IPortalInfo

Properties

AdministratorId

Gets or sets userID of the user who is the admininistrator of the portal.

Declaration

int AdministratorId { get; set; }

Property Value

Type	Description
System.Int32	UserId of the user who is the portal admin.

AdministratorRoleId

Gets or sets the RoleId of the Security Role of the Administrators group of the portal.

Declaration

int AdministratorRoleId { get; set; }

Property Value

Type	Description
System.Int32	RoleId of de Administrators Security Role.

AdministratorRoleName

Gets or sets the actual name of the Administrators group of the portal. This name is retrieved from the RoleController object.

Declaration

string AdministratorRoleName { get; set; }

Property Value

Type	Description
System.String	The name of the Administrators group.

AdminTabId

Gets or sets tabId at which admin tasks start.

Declaration

int AdminTabId { get; set; }

Property Value

Type	Description
System.Int32	TabID of admin tasks.

CrmVersion

Gets or sets current host version.

Declaration

string CrmVersion { get; set; }

Property Value

Type	Description
System.String

CultureCode

Gets or sets the Culture Code of the portal.

Declaration

string CultureCode { get; set; }

Property Value

Type	Description
System.String

Custom404TabId

Gets or sets tabid of the Custom 404 page.

Declaration

int Custom404TabId { get; set; }

Property Value

Type	Description
System.Int32	Tabid of the Custom 404 page.

Custom500TabId

Gets or sets tabid of the Custom 500 error page.

Declaration

int Custom500TabId { get; set; }

Property Value

Type	Description
System.Int32	Tabid of the Custom 500 error page.

DefaultLanguage

Gets or sets default language for the portal.

Declaration

string DefaultLanguage { get; set; }

Property Value

Type	Description
System.String	Default language of the portal.

Description

Gets or sets description of the portal.

Declaration

string Description { get; set; }

Property Value

Type	Description
System.String	Description of the portal.

Email

Gets or sets the default e-mail to be used in the portal.

Declaration

string Email { get; set; }

Property Value

Type	Description
System.String	E-mail of the portal.

ExpiryDate

Gets or sets date at which the portal expires.

Declaration

DateTime ExpiryDate { get; set; }

Property Value

Type	Description
DateTime	Date of expiration of the portal.

FooterText

Gets or sets the footer text as specified in the Portal settings.

Declaration

string FooterText { get; set; }

Property Value

Type	Description
System.String	Footer text of the portal.

Remarks

This show the usage of the FooterText property

txtFooterText.Text = objPortal.FooterText

GUID

Gets or sets GUID of the portal info object.

Declaration

Guid GUID { get; set; }

Property Value

Type	Description
Guid	Portal info Object GUID.

HomeDirectory

Gets or sets home directory of the portal (logical path).

Declaration

string HomeDirectory { get; set; }

Property Value

Type	Description
System.String	Portal home directory.

HomeDirectoryMapPath

Gets fysical path on disk of the home directory of the portal.

Declaration

string HomeDirectoryMapPath { get; }

Property Value

Type	Description
System.String	Physical path on disk of the home directory of the portal.

HomeSystemDirectory

Gets home System (local) directory of the portal (logical path).

Declaration

string HomeSystemDirectory { get; }

Property Value

Type	Description
System.String	Portal home system directory.

HomeSystemDirectoryMapPath

Gets fysical path on disk of the home directory of the portal.

Declaration

string HomeSystemDirectoryMapPath { get; }

Property Value

Type	Description
System.String	Physical path on disk of the home directory of the portal.

HomeTabId

Gets or sets tabdId of the Home page.

Declaration

int HomeTabId { get; set; }

Property Value

Type	Description
System.Int32	TabId of the Home page.

HostSpace

Gets or sets total disk space allowed for the portal (Mb). 0 means not limited.

Declaration

int HostSpace { get; set; }

Property Value

Type	Description
System.Int32	Diskspace allowed for the portal.

KeyWords

Gets or sets keywords (separated by ,) for this portal.

Declaration

string KeyWords { get; set; }

Property Value

Type	Description
System.String	Keywords seperated by .

LoginTabId

Gets or sets tabId with the login control, page to login.

Declaration

int LoginTabId { get; set; }

Property Value

Type	Description
System.Int32	TabId of the Login page.

LogoFile

Gets or sets the logo associated with the portal. The admin can set the logo in the portal settings.

Declaration

string LogoFile { get; set; }

Property Value

Type	Description
System.String	URL of the logo.

PageQuota

Gets or sets number of portal pages allowed in the portal. 0 means not limited.

Declaration

int PageQuota { get; set; }

Property Value

Type	Description
System.Int32	Number of portal pages allowed.

PortalGroupId

Gets or sets contains the id of the portal group that the portal belongs to Will be null or -1 (null.nullinteger) if the portal does not belong to a portal group.

Declaration

int PortalGroupId { get; set; }

Property Value

Type	Description
System.Int32

PortalId

Gets or sets unique idenitifier of the Portal within the site.

Declaration

int PortalId { get; set; }

Property Value

Type	Description
System.Int32	Portal identifier.

PortalName

Gets or sets name of the portal. Can be set at creation time, Admin can change the name in the portal settings.

Declaration

string PortalName { get; set; }

Property Value

Type	Description
System.String	Name of the portal.

PrivacyTabId

Gets or sets tabid of the Privacy Statement page.

Declaration

int PrivacyTabId { get; set; }

Property Value

Type	Description
System.Int32	Tabid of the Privacy Statement page.

RegisteredRoleId

Gets or sets the RoleId of the Registered users group of the portal.

Declaration

int RegisteredRoleId { get; set; }

Property Value

Type	Description
System.Int32	RoleId of the Registered users.

RegisteredRoleName

Gets or sets the actual name of the Registerd Users group of the portal. This name is retrieved from the RoleController object.

Declaration

string RegisteredRoleName { get; set; }

Property Value

Type	Description
System.String	The name of the Registerd Users group.

RegisterTabId

Gets or sets tabid of the Registration page.

Declaration

int RegisterTabId { get; set; }

Property Value

Type	Description
System.Int32	TabId of the Registration page.

SearchTabId

Gets or sets tabid of the Search profile page.

Declaration

int SearchTabId { get; set; }

Property Value

Type	Description
System.Int32	TabdId of the Search Results page.

SplashTabId

Gets or sets tabdId of the splash page. If 0, there is no splash page.

Declaration

int SplashTabId { get; set; }

Property Value

Type	Description
System.Int32	TabdId of the Splash page.

SuperTabId

Gets or sets tabId at which Host tasks start.

Declaration

int SuperTabId { get; set; }

Property Value

Type	Description
System.Int32	TabId of Host tasks.

TermsTabId

Gets or sets tabid of the Terms of Use page.

Declaration

int TermsTabId { get; set; }

Property Value

Type	Description
System.Int32	Tabid of the Terms of Use page.

UserQuota

Gets or sets number of registered users allowed in the portal. 0 means not limited.

Declaration

int UserQuota { get; set; }

Property Value

Type	Description
System.Int32	Number of registered users allowed.

UserRegistration

Gets or sets type of registration that the portal supports.

Declaration

int UserRegistration { get; set; }

Property Value

Type	Description
System.Int32	Type of registration.

UserTabId

Gets or sets tabid of the User profile page.

Declaration

int UserTabId { get; set; }

Property Value

Type	Description
System.Int32	TabdId of the User profile page.

Extension Methods

JsonExtensionsWeb.ToJson(Object)