Class TabInfo

Information about a page within a DNN site.

Inheritance

System.Object

BaseEntityInfo

ContentItem

TabInfo

Implements

IHydratable

IPropertyAccess

Inherited Members

ContentItem.Metadata

ContentItem.Terms

ContentItem.Files

ContentItem.Videos

ContentItem.Images

ContentItem.ContentItemId

ContentItem.Content

ContentItem.ContentKey

ContentItem.ContentTypeId

ContentItem.Indexed

ContentItem.ModuleID

ContentItem.TabID

ContentItem.ContentTitle

ContentItem.StateID

ContentItem.FillInternal(IDataReader)

ContentItem.Clone(ContentItem, ContentItem)

BaseEntityInfo.CreatedByUserID

BaseEntityInfo.CreatedOnDate

BaseEntityInfo.LastModifiedByUserID

BaseEntityInfo.LastModifiedOnDate

BaseEntityInfo.CreatedByUser(Int32)

BaseEntityInfo.LastModifiedByUser(Int32)

BaseEntityInfo.CloneBaseProperties(BaseEntityInfo, BaseEntityInfo)

Namespace: DotNetNuke.Entities.Tabs

Assembly: DotNetNuke.dll

Syntax

public class TabInfo : ContentItem, IHydratable, IPropertyAccess

Constructors

| Improve this Doc View Source

TabInfo()

Initializes a new instance of the TabInfo class.

Declaration

public TabInfo()

Properties

| Improve this Doc View Source

AliasSkins

Gets a collection of TabAliasSkinInfo for this page.

Declaration

public List<TabAliasSkinInfo> AliasSkins { get; }

Property Value

Type	Description
List<TabAliasSkinInfo>

| Improve this Doc View Source

AllowIndex

Gets a value indicating whether DNN's search index should include this page.

Declaration

public bool AllowIndex { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

BreadCrumbs

Gets or sets the collection of bread crumb pages (i.e. the parent, grandparent, etc. of this page).

Declaration

public ArrayList BreadCrumbs { get; set; }

Property Value

Type	Description
ArrayList	An with TabInfo instances.

| Improve this Doc View Source

Cacheability

Gets the cache level for property access.

Declaration

public CacheLevel Cacheability { get; }

Property Value

Type	Description
CacheLevel

| Improve this Doc View Source

ChildModules

Gets the modules on this page.

Declaration

public Dictionary<int, ModuleInfo> ChildModules { get; }

Property Value

Type	Description
Dictionary<System.Int32, ModuleInfo>	A mapping between Module ID and ModuleInfo.

| Improve this Doc View Source

ContainerPath

Gets or sets the path to the directory with ContainerSrc.

Declaration

public string ContainerPath { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ContainerSrc

Gets or sets the path to the default container for this page, if there is one.

Declaration

public string ContainerSrc { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CultureCode

Gets or sets the culture code for this page, if there is one.

Declaration

public string CultureCode { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CustomAliases

Gets a collection of custom aliases for this page.

Declaration

public Dictionary<string, string> CustomAliases { get; }

Property Value

Type	Description
Dictionary<System.String, System.String>	A mapping from CultureCode to HTTP Alias.

| Improve this Doc View Source

DefaultLanguageGuid

Gets or sets the for the default language version of this page.

Declaration

public Guid DefaultLanguageGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

DefaultLanguageTab

Gets info for the default language version of this page, if it exists.

Declaration

public TabInfo DefaultLanguageTab { get; }

Property Value

Type	Description
TabInfo	A TabInfo instance, or `null`.

| Improve this Doc View Source

Description

Gets or sets the page description.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DisableLink

Gets or sets a value indicating whether the link to this page should be rendered as disabled.

Declaration

public bool DisableLink { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

DoNotRedirect

Gets a value indicating whether this page is configured not to redirect.

Declaration

public bool DoNotRedirect { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

EndDate

Gets or sets this page's end date.

Declaration

public DateTime EndDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

FullUrl

Gets the full URL for this page.

Declaration

public string FullUrl { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HasAVisibleVersion

Gets a value indicating whether this page has a version that is visible to the current user.

Declaration

public bool HasAVisibleVersion { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

HasBeenPublished

Gets or sets a value indicating whether this page has been published.

Declaration

public bool HasBeenPublished { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

HasChildren

Gets or sets a value indicating whether this instance has children.

Declaration

public bool HasChildren { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IconFile

Gets or sets the path to the icon.

Declaration

public string IconFile { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IconFileLarge

Gets or sets the path to the large icon.

Declaration

public string IconFileLarge { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IconFileLargeRaw

Gets the large icon file URL, as it is stored in the database.

Declaration

public string IconFileLargeRaw { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IconFileRaw

Gets the icon file URL, as it is stored in the database.

Declaration

public string IconFileRaw { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IndentedTabName

Gets the indented name of this page (i.e. with "..." at the beginning based on the page's Level).

Declaration

public string IndentedTabName { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IsDefaultLanguage

Gets a value indicating whether this page is the default language version.

Declaration

public bool IsDefaultLanguage { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDeleted

Gets or sets a value indicating whether this page is deleted.

Declaration

public bool IsDeleted { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsNeutralCulture

Gets a value indicating whether this page is not for any specific culture/language.

Declaration

public bool IsNeutralCulture { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsSecure

Gets or sets a value indicating whether this page requires HTTPS.

Declaration

public bool IsSecure { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsSuperTab

Gets or sets a value indicating whether this page is a host level page that doesn't belong to any portal.

Declaration

public bool IsSuperTab { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsSystem

Gets or sets a value indicating whether this page is required by DNN.

Declaration

public bool IsSystem { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsTranslated

Gets a value indicating whether this page is translated.

Declaration

public bool IsTranslated { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsVisible

Gets or sets a value indicating whether this page should be visible in the menu.

Declaration

public bool IsVisible { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

KeyID

Gets or sets the key ID.

Declaration

public override int KeyID { get; set; }

Property Value

Type	Description
System.Int32	The key ID.

Overrides

ContentItem.KeyID

Remarks

If you derive class has its own key id, please override this property and set the value to your own key id.

| Improve this Doc View Source

KeyWords

Gets or sets the meta keywords for the page.

Declaration

public string KeyWords { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Level

Gets or sets the level of the page, i.e. how may ancestors (parent, grandparent, etc.) it has.

Declaration

public int Level { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

LocalizedTabName

Gets the name of the page for the current culture.

Declaration

public string LocalizedTabName { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LocalizedTabs

Gets a collection of pages that are localized children of this page.

Declaration

public Dictionary<string, TabInfo> LocalizedTabs { get; }

Property Value

Type	Description
Dictionary<System.String, TabInfo>	A mapping from CultureCode to TabInfo.

| Improve this Doc View Source

LocalizedVersionGuid

Gets or sets the for the localized version.

Declaration

public Guid LocalizedVersionGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

Modules

Gets or sets a collection of the modules on this page.

Declaration

public ArrayList Modules { get; set; }

Property Value

Type	Description
ArrayList	An of ModuleInfo.

| Improve this Doc View Source

PageHeadText

Gets or sets the page head text, i.e. content to render in the <head> of the page.

Declaration

public string PageHeadText { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Panes

Gets a list of the names of the panes available to the page.

Declaration

public ArrayList Panes { get; }

Property Value

Type	Description
ArrayList	An of values with the IDs of the panes on the page.

| Improve this Doc View Source

ParentId

Gets or sets the ID of this page's parent page (or NullInteger if it has no parent).

Declaration

public int ParentId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PermanentRedirect

Gets or sets a value indicating whether the redirect configured for this page should be a permanent redirect.

Declaration

public bool PermanentRedirect { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

PortalID

Gets or sets the ID of the portal/site this page belongs to.

Declaration

public int PortalID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

RefreshInterval

Gets or sets the number of seconds after which the page should refresh.

Declaration

public int RefreshInterval { get; set; }

Property Value

Type	Description
System.Int32

Remarks

If this value is greater than zero, it is set as the content of the <meta http-equiv="refresh"> tag, which instructs the browser to refresh the page.

| Improve this Doc View Source

SiteMapPriority

Gets or sets the priority of this page in the search engine site map, a value between 0.0 and 1.0, indicating the relative priority of the page compared to other pages on the site.

Declaration

public float SiteMapPriority { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

SkinDoctype

Gets or sets the doctype statement to be used when rendering this page.

Declaration

public string SkinDoctype { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SkinPath

Gets or sets the path to the directory with SkinSrc.

Declaration

public string SkinPath { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SkinSrc

Gets or sets the path to the skin control for this page.

Declaration

public string SkinSrc { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

StartDate

Gets or sets the page's start date.

Declaration

public DateTime StartDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

TabName

Gets or sets the name of the page.

Declaration

public string TabName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

TabOrder

Gets or sets the relative order of this page in relation to its siblings.

Declaration

public int TabOrder { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

TabPath

Gets or sets the tab path, an identifier in the format "//PageOne//MyParentPage//ThisPage".

Declaration

public string TabPath { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

TabPermissions

Gets the permissions collection for the page.

Declaration

public TabPermissionCollection TabPermissions { get; }

Property Value

Type	Description
TabPermissionCollection

| Improve this Doc View Source

TabPermissionsSpecified

Gets a value indicating whether the tab permissions are specified.

Declaration

public bool TabPermissionsSpecified { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

TabSettings

Gets the settings collection for the page.

Declaration

public Hashtable TabSettings { get; }

Property Value

Type	Description
Hashtable

| Improve this Doc View Source

TabType

Gets the TabType for the page.

Declaration

public TabType TabType { get; }

Property Value

Type	Description
TabType

TabUrls

Gets a collection of page-specific URLs.

Declaration

public List<TabUrlInfo> TabUrls { get; }

Property Value

Type	Description
List<TabUrlInfo>

| Improve this Doc View Source

Title

Gets or sets the HTML title to be rendered for this page.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

UniqueId

Gets or sets the unique ID identifying this page.

Declaration

public Guid UniqueId { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

Url

Gets or sets the URL for this page if it is a redirect.

Declaration

public string Url { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

UseBaseFriendlyUrls

Gets or sets a value indicating whether this page uses friendly URLs.

Declaration

public bool UseBaseFriendlyUrls { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

VersionGuid

Gets or sets the identifying this version of the page.

Declaration

public Guid VersionGuid { get; set; }

Property Value

Type	Description
Guid

Methods

| Improve this Doc View Source

Clone()

Clones this instance.

Declaration

public TabInfo Clone()

Returns

Type	Description
TabInfo	A new TabInfo instance.

| Improve this Doc View Source

Fill(IDataReader)

Fill this content object will the information from data reader.

Declaration

public override void Fill(IDataReader dr)

Parameters

Type	Name	Description
IDataReader	dr	The data reader.

Overrides

ContentItem.Fill(IDataReader)

GetCurrentUrl(String)

Gets the URL for the given cultureCode.

Declaration

public string GetCurrentUrl(string cultureCode)

Parameters

Type	Name	Description
System.String	cultureCode	The culture code.

Returns

Type	Description
System.String	The URL or .

| Improve this Doc View Source

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

Gets a property.

Declaration

public string GetProperty(string propertyName, string format, CultureInfo formatProvider, UserInfo accessingUser, Scope currentScope, 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	currentScope
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.

| Improve this Doc View Source

GetTags()

Gets the tag names as a comma-delimited .

Declaration

public string GetTags()

Returns

Type	Description
System.String	A comma-delimited .

Implements

IHydratable

IPropertyAccess

Extension Methods

JsonExtensionsWeb.ToJson(Object)