Class PortalInfo

PortalInfo provides a base class for Portal information This class inherits from the BaseEntityInfo and is Hydratable.

Inheritance

System.Object

BaseEntityInfo

PortalInfo

Implements

IHydratable

IPortalInfo

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 PortalInfo : BaseEntityInfo, IHydratable, IPortalInfo

Remarks

IHydratable This example shows how the PortalInfo class is used to get physical file names

Public ReadOnly Property PhysicalPath() As String
      Get
          Dim _PhysicalPath As String
          Dim PortalSettings As PortalSettings = Nothing
          If Not HttpContext.Current Is Nothing Then
              PortalSettings = PortalController.Instance.GetCurrentPortalSettings()
          End If
          If PortalId = Null.NullInteger Then
              _PhysicalPath = DotNetNuke.Common.Globals.HostMapPath + RelativePath
          Else
              If PortalSettings Is Nothing OrElse PortalSettings.PortalId <> PortalId Then
                  ' Get the PortalInfo  based on the Portalid
                  Dim objPortals As New PortalController()
                  Dim objPortal As PortalInfo = objPortals.GetPortal(PortalId)
                  _PhysicalPath = objPortal.HomeDirectoryMapPath + RelativePath
              Else
                  _PhysicalPath = PortalSettings.HomeDirectoryMapPath + RelativePath
              End If
          End If
          Return _PhysicalPath.Replace("/", "\")
      End Get
End Property

Constructors

| Improve this Doc View Source

PortalInfo()

Initializes a new instance of the PortalInfo class.

Declaration

public PortalInfo()

Remarks

This example illustrates the creation of a new PortalInfo object

For Each portal As PortalInfo In New PortalController().GetPortals
    Dim portalID As Integer = portal.PortalID
    ...
Next

Properties

| Improve this Doc View Source

AdministratorId

Declaration

public int AdministratorId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

AdministratorRoleId

Declaration

public int AdministratorRoleId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

AdministratorRoleName

Declaration

public string AdministratorRoleName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

AdminTabId

Declaration

public int AdminTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

BackgroundFile

Gets or sets image (bitmap) file that is used as background for the portal.

Declaration

public string BackgroundFile { get; set; }

Property Value

Type	Description
System.String	Name of the file that is used as background.

| Improve this Doc View Source

BannerAdvertising

Gets or sets setting for the type of banner advertising in the portal.

Declaration

public int BannerAdvertising { get; set; }

Property Value

Type	Description
System.Int32	Type of banner advertising.

| Improve this Doc View Source

CrmVersion

Declaration

public string CrmVersion { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CultureCode

Declaration

public string CultureCode { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Currency

Gets or sets currency format that is used in the portal.

Declaration

public string Currency { get; set; }

Property Value

Type	Description
System.String	Currency of the portal.

| Improve this Doc View Source

Custom404TabId

Declaration

public int Custom404TabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Custom500TabId

Declaration

public int Custom500TabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

DefaultLanguage

Declaration

public string DefaultLanguage { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Description

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Email

Declaration

public string Email { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ExpiryDate

Declaration

public DateTime ExpiryDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

FooterText

Declaration

public string FooterText { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

GUID

Declaration

public Guid GUID { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

HomeDirectory

Declaration

public string HomeDirectory { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HomeDirectoryMapPath

Declaration

public string HomeDirectoryMapPath { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HomeSystemDirectory

Declaration

public string HomeSystemDirectory { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HomeSystemDirectoryMapPath

Declaration

public string HomeSystemDirectoryMapPath { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HomeTabId

Declaration

public int HomeTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

HostFee

Gets or sets amount of currency that is used as a hosting fee of the portal.

Declaration

public float HostFee { get; set; }

Property Value

Type	Description
System.Single	Currency amount hosting fee.

| Improve this Doc View Source

HostSpace

Declaration

public int HostSpace { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

KeyID

Declaration

public int KeyID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

KeyWords

Declaration

public string KeyWords { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LoginTabId

Declaration

public int LoginTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

LogoFile

Declaration

public string LogoFile { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PageQuota

Declaration

public int PageQuota { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Pages

Gets or sets actual number of pages of the portal.

Declaration

public int Pages { get; set; }

Property Value

Type	Description
System.Int32	Number of pages of the portal.

| Improve this Doc View Source

PaymentProcessor

Gets or sets name of the Payment processor that is used for portal payments, e.g. PayPal.

Declaration

public string PaymentProcessor { get; set; }

Property Value

Type	Description
System.String	Name of the portal payment processor.

| Improve this Doc View Source

PortalGroupID

Declaration

public int PortalGroupID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PortalID

Declaration

public int PortalID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PortalName

Declaration

public string PortalName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PrivacyTabId

Declaration

public int PrivacyTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

ProcessorPassword

Gets or sets password to use in the payment processor.

Declaration

public string ProcessorPassword { get; set; }

Property Value

Type	Description
System.String	Payment Processor password.

| Improve this Doc View Source

ProcessorUserId

Gets or sets payment Processor userId.

Declaration

public string ProcessorUserId { get; set; }

Property Value

Type	Description
System.String	Payment Processor userId

| Improve this Doc View Source

RegisteredRoleId

Declaration

public int RegisteredRoleId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

RegisteredRoleName

Declaration

public string RegisteredRoleName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

RegisterTabId

Declaration

public int RegisterTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

SearchTabId

Declaration

public int SearchTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

SiteLogHistory

Declaration

public int SiteLogHistory { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

SplashTabId

Declaration

public int SplashTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

SuperTabId

Declaration

public int SuperTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

TermsTabId

Declaration

public int TermsTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

TimeZoneOffset

Declaration

public int TimeZoneOffset { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

UserQuota

Declaration

public int UserQuota { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

UserRegistration

Declaration

public int UserRegistration { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Users

Gets or sets actual number of actual users for this portal.

Declaration

public int Users { get; set; }

Property Value

Type	Description
System.Int32	Number of users for the portal.

| Improve this Doc View Source

UserTabId

Declaration

public int UserTabId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Version

Gets or sets dNN Version # of the portal installation.

Declaration

public string Version { get; set; }

Property Value

Type	Description
System.String	Version # of the portal installation.

Methods

| Improve this Doc View Source

Fill(IDataReader)

Fills a PortalInfo from a Data Reader.

Declaration

public void Fill(IDataReader dr)

Parameters

Type	Name	Description
IDataReader	dr	The Data Reader to use.

Remarks

Standard IHydratable.Fill implementation. KeyID

Implements

IHydratable

IPortalInfo

Extension Methods

JsonExtensionsWeb.ToJson(Object)