Interface ITabController

Do not implement. This interface is only implemented by the DotNetNuke core framework. Outside the framework it should used as a type and for unit test purposes only. There is no guarantee that this interface will not change.

Namespace: DotNetNuke.Entities.Tabs

Assembly: DotNetNuke.dll

Syntax

public interface ITabController

Methods

AddMissingLanguages(Int32, Int32)

Adds localized copies of the page in all missing languages.

Declaration

void AddMissingLanguages(int portalId, int tabId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId

AddMissingLanguagesWithWarnings(Int32, Int32)

Adds localized copies of the page in all missing languages.

Declaration

bool AddMissingLanguagesWithWarnings(int portalId, int tabId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId

Returns

Type	Description
System.Boolean	Whether all missing languages were added.

AddTab(TabInfo, Boolean)

Adds a tab.

Declaration

int AddTab(TabInfo tab, bool includeAllTabsModules)

Parameters

Type	Name	Description
TabInfo	tab	The tab to be added.
System.Boolean	includeAllTabsModules	Flag that indicates whether to add the "AllTabs" Modules.

Returns

Type	Description
System.Int32	The new tab ID.

Remarks

The tab is added to the end of the current Level.

AddTab(TabInfo)

Adds a tab.

Declaration

int AddTab(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The tab to be added.

Returns

Type	Description
System.Int32	The new tab ID.

Remarks

The tab is added to the end of the current Level.

AddTabAfter(TabInfo, Int32)

Adds a tab after the specified tab.

Declaration

int AddTabAfter(TabInfo tab, int afterTabId)

Parameters

Type	Name	Description
TabInfo	tab	The tab to be added.
System.Int32	afterTabId	Id of the tab after which this tab is added.

Returns

Type	Description
System.Int32	The new tab ID.

AddTabBefore(TabInfo, Int32)

Adds a tab before the specified tab.

Declaration

int AddTabBefore(TabInfo objTab, int beforeTabId)

Parameters

Type	Name	Description
TabInfo	objTab	The tab to be added.
System.Int32	beforeTabId	Id of the tab before which this tab is added.

Returns

Type	Description
System.Int32	The new tab ID.

ClearCache(Int32)

Clears tabs and portal cache for the specific portal.

Declaration

void ClearCache(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.

ConvertTabToNeutralLanguage(Int32, Int32, String, Boolean)

Converts one single tab to a neutral culture clears the tab cache optionally.

Declaration

void ConvertTabToNeutralLanguage(int portalId, int tabId, string cultureCode, bool clearCache)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId
System.String	cultureCode
System.Boolean	clearCache

CreateContentItem(TabInfo)

Creates content item for the tab..

Declaration

void CreateContentItem(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The updated tab.

CreateLocalizedCopies(TabInfo)

Creates the localized copies.

Declaration

void CreateLocalizedCopies(TabInfo originalTab)

Parameters

Type	Name	Description
TabInfo	originalTab	The original tab.

CreateLocalizedCopy(TabInfo, Locale, Boolean)

Creates the localized copy.

Declaration

void CreateLocalizedCopy(TabInfo originalTab, Locale locale, bool clearCache)

Parameters

Type	Name	Description
TabInfo	originalTab	The original tab.
Locale	locale	The locale.
System.Boolean	clearCache	Clear the cache?.

DeleteTab(Int32, Int32, Boolean)

Deletes a tab permanently from the database.

Declaration

void DeleteTab(int tabId, int portalId, bool deleteDescendants)

Parameters

Type	Name	Description
System.Int32	tabId	The tab id.
System.Int32	portalId	The portal id.
System.Boolean	deleteDescendants	if set to true will delete all child tabs.

DeleteTab(Int32, Int32)

Deletes a tab permanently from the database.

Declaration

void DeleteTab(int tabId, int portalId)

Parameters

Type	Name	Description
System.Int32	tabId	TabId of the tab to be deleted.
System.Int32	portalId	PortalId of the portal.

Remarks

The tab will not delete if it has child tab(s).

DeleteTabSetting(Int32, String)

Delete a Setting of a tab instance.

Declaration

void DeleteTabSetting(int tabId, string settingName)

Parameters

Type	Name	Description
System.Int32	tabId	ID of the affected tab.
System.String	settingName	Name of the setting to be deleted.

DeleteTabSettings(Int32)

Delete all Settings of a tab instance.

Declaration

void DeleteTabSettings(int tabId)

Parameters

Type	Name	Description
System.Int32	tabId	ID of the affected tab.

DeleteTabUrl(TabUrlInfo, Int32, Boolean)

Delete a taburl.

Declaration

void DeleteTabUrl(TabUrlInfo tabUrl, int portalId, bool clearCache)

Parameters

Type	Name	Description
TabUrlInfo	tabUrl	the taburl.
System.Int32	portalId	the portal.
System.Boolean	clearCache	whether to clear the cache.

DeleteTranslatedTabs(Int32, String, Boolean)

Deletes all tabs for a specific language. Double checks if we are not deleting pages for the default language Clears the tab cache optionally.

Declaration

bool DeleteTranslatedTabs(int portalId, string cultureCode, bool clearCache)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	cultureCode
System.Boolean	clearCache

Returns

Type	Description
System.Boolean	true if the deletion completes.

EnsureNeutralLanguage(Int32, String, Boolean)

Reverts page culture back to Neutral (Null), to ensure a non localized site clears the tab cache optionally.

Declaration

void EnsureNeutralLanguage(int portalId, string cultureCode, bool clearCache)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	cultureCode
System.Boolean	clearCache

GetAliasSkins(Int32, Int32)

Get the list of skins per alias at tab level.

Declaration

List<TabAliasSkinInfo> GetAliasSkins(int tabId, int portalId)

Parameters

Type	Name	Description
System.Int32	tabId	the tab id.
System.Int32	portalId	the portal id.

Returns

Type	Description
List<TabAliasSkinInfo>	list of TabAliasSkinInfo.

GetCustomAliases(Int32, Int32)

Get the list of custom aliases associated with a page (tab).

Declaration

Dictionary<string, string> GetCustomAliases(int tabId, int portalId)

Parameters

Type	Name	Description
System.Int32	tabId	the tab id.
System.Int32	portalId	the portal id.

Returns

Type	Description
Dictionary<System.String, System.String>	dictionary of tabid and aliases.

GetTab(Int32, Int32, Boolean)

Gets the tab.

Declaration

TabInfo GetTab(int tabId, int portalId, bool ignoreCache)

Parameters

Type	Name	Description
System.Int32	tabId	The tab id.
System.Int32	portalId	The portal id.
System.Boolean	ignoreCache	if set to true will get tab info directly from database.

Returns

Type	Description
TabInfo	tab info.

GetTab(Int32, Int32)

Gets the tab.

Declaration

TabInfo GetTab(int tabId, int portalId)

Parameters

Type	Name	Description
System.Int32	tabId	The tab id.
System.Int32	portalId	The portal id.

Returns

Type	Description
TabInfo	tab info.

GetTabByCulture(Int32, Int32, Locale)

Gets the tab by culture.

Declaration

TabInfo GetTabByCulture(int tabId, int portalId, Locale locale)

Parameters

Type	Name	Description
System.Int32	tabId	The tab id.
System.Int32	portalId	The portal id.
Locale	locale	The locale.

Returns

Type	Description
TabInfo	tab info.

GetTabByName(String, Int32, Int32)

Gets the name of the tab by name and parent id.

Declaration

TabInfo GetTabByName(string tabName, int portalId, int parentId)

Parameters

Type	Name	Description
System.String	tabName	Name of the tab.
System.Int32	portalId	The portal id.
System.Int32	parentId	The parent id.

Returns

Type	Description
TabInfo	tab info.

GetTabByName(String, Int32)

Gets the name of the tab by name.

Declaration

TabInfo GetTabByName(string tabName, int portalId)

Parameters

Type	Name	Description
System.String	tabName	Name of the tab.
System.Int32	portalId	The portal id.

Returns

Type	Description
TabInfo	tab info.

GetTabsByModuleID(Int32)

Gets the tabs which use the module.

Declaration

IDictionary<int, TabInfo> GetTabsByModuleID(int moduleID)

Parameters

Type	Name	Description
System.Int32	moduleID	The module ID.

Returns

Type	Description
IDictionary<System.Int32, TabInfo>	tab collection.

GetTabsByPackageID(Int32, Int32, Boolean)

Gets the tabs which use the package.

Declaration

IDictionary<int, TabInfo> GetTabsByPackageID(int portalID, int packageID, bool forHost)

Parameters

Type	Name	Description
System.Int32	portalID	The portal ID.
System.Int32	packageID	The package ID.
System.Boolean	forHost	if set to true [for host].

Returns

Type	Description
IDictionary<System.Int32, TabInfo>	tab collection.

GetTabsByPortal(Int32)

Get the actual visible tabs for a given portal id. System Tabs and Admin Tabs are excluded from the result set.

Declaration

TabCollection GetTabsByPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
TabCollection	tab collection.

GetTabsByTabModuleID(Int32)

Gets the tabs which use the module.

Declaration

IDictionary<int, TabInfo> GetTabsByTabModuleID(int tabModuleId)

Parameters

Type	Name	Description
System.Int32	tabModuleId	The tabmodule ID.

Returns

Type	Description
IDictionary<System.Int32, TabInfo>	tab collection.

GetTabSettings(Int32)

read all settings for a tab from TabSettings table.

Declaration

Hashtable GetTabSettings(int tabId)

Parameters

Type	Name	Description
System.Int32	tabId	ID of the Tab to query.

Returns

Type	Description
Hashtable	(cached) hashtable containing all settings.

GetTabUrls(Int32, Int32)

Get the list of url's associated with a page (tab).

Declaration

List<TabUrlInfo> GetTabUrls(int tabId, int portalId)

Parameters

Type	Name	Description
System.Int32	tabId	the tab id.
System.Int32	portalId	the portal id.

Returns

Type	Description
List<TabUrlInfo>	list of urls associated with a tab.

GetUserTabsByPortal(Int32)

Gets the tabs by portal.

Declaration

TabCollection GetUserTabsByPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.

Returns

Type	Description
TabCollection	tab collection.

GiveTranslatorRoleEditRights(TabInfo, Dictionary<Int32, UserInfo>)

Gives the translator role edit rights.

Declaration

void GiveTranslatorRoleEditRights(TabInfo localizedTab, Dictionary<int, UserInfo> users)

Parameters

Type	Name	Description
TabInfo	localizedTab	The localized tab.
Dictionary<System.Int32, UserInfo>	users	The users.

HasMissingLanguages(Int32, Int32)

Returns True if a page is missing a translated version in at least one other language.

Declaration

bool HasMissingLanguages(int portalId, int tabId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId

Returns

Type	Description
System.Boolean	true if the page has missing languages, otherwise false.

IsHostOrAdminPage(TabInfo)

Determines whether is host or admin tab.

Declaration

bool IsHostOrAdminPage(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The tab info.

Returns

Type	Description
System.Boolean	true if the page is a host or admin page, otherwise false.

IsTabPublished(TabInfo)

Checks whether the tab is published. Published means: view permissions of tab are identical to the DefaultLanguageTab.

Declaration

bool IsTabPublished(TabInfo publishTab)

Parameters

Type	Name	Description
TabInfo	publishTab	The tab that is checked.

Returns

Type	Description
System.Boolean	true if tab is published.

LocalizeTab(TabInfo, Locale, Boolean)

Localizes the tab, with optional clear cache.

Declaration

void LocalizeTab(TabInfo originalTab, Locale locale, bool clearCache)

Parameters

Type	Name	Description
TabInfo	originalTab
Locale	locale
System.Boolean	clearCache

LocalizeTab(TabInfo, Locale)

Localizes the tab.

Declaration

void LocalizeTab(TabInfo originalTab, Locale locale)

Parameters

Type	Name	Description
TabInfo	originalTab	The original tab.
Locale	locale	The locale.

MarkAsPublished(TabInfo)

It marks a page as published at least once.

Declaration

void MarkAsPublished(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The Tab to be marked.

MoveTabAfter(TabInfo, Int32)

Moves the tab after a specific tab.

Declaration

void MoveTabAfter(TabInfo tab, int afterTabId)

Parameters

Type	Name	Description
TabInfo	tab	The tab want to move.
System.Int32	afterTabId	will move objTab after this tab.

MoveTabBefore(TabInfo, Int32)

Moves the tab before a specific tab.

Declaration

void MoveTabBefore(TabInfo tab, int beforeTabId)

Parameters

Type	Name	Description
TabInfo	tab	The tab want to move.
System.Int32	beforeTabId	will move objTab before this tab.

MoveTabToParent(TabInfo, Int32)

Moves the tab to a new parent.

Declaration

void MoveTabToParent(TabInfo tab, int parentId)

Parameters

Type	Name	Description
TabInfo	tab	The tab want to move.
System.Int32	parentId	will move tab to this parent.

PopulateBreadCrumbs(ref TabInfo)

Populates the bread crumbs.

Declaration

void PopulateBreadCrumbs(ref TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The tab.

PopulateBreadCrumbs(Int32, ref ArrayList, Int32)

Populates the bread crumbs.

Declaration

void PopulateBreadCrumbs(int portalID, ref ArrayList breadCrumbs, int tabID)

Parameters

Type	Name	Description
System.Int32	portalID	The portal ID.
ArrayList	breadCrumbs	The bread crumbs.
System.Int32	tabID	The tab ID.

PublishTab(TabInfo)

Publishes the tab. Set the VIEW permissions to All Users.

Declaration

void PublishTab(TabInfo publishTab)

Parameters

Type	Name	Description
TabInfo	publishTab	The publish tab.

PublishTabs(List<TabInfo>)

Publishes the tab. Set the VIEW permissions to All Users.

Declaration

void PublishTabs(List<TabInfo> tabs)

Parameters

Type	Name	Description
List<TabInfo>	tabs	The tabs.

RefreshCache(Int32, Int32)

Refresh the tabinfo in cache object of portal tabs collection, use this instead of clear the whole cache to improve performance.

Declaration

void RefreshCache(int portalId, int tabId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId

RestoreTab(TabInfo, PortalSettings)

Restores the tab.

Declaration

void RestoreTab(TabInfo tab, PortalSettings portalSettings)

Parameters

Type	Name	Description
TabInfo	tab	The obj tab.
PortalSettings	portalSettings	The portal settings.

SaveTabUrl(TabUrlInfo, Int32, Boolean)

Save url information for a page (tab).

Declaration

void SaveTabUrl(TabUrlInfo tabUrl, int portalId, bool clearCache)

Parameters

Type	Name	Description
TabUrlInfo	tabUrl	the tab url.
System.Int32	portalId	the portal id.
System.Boolean	clearCache	whether to clear the cache.

SoftDeleteTab(Int32, PortalSettings)

Soft Deletes the tab by setting the IsDeleted property to true.

Declaration

bool SoftDeleteTab(int tabId, PortalSettings portalSettings)

Parameters

Type	Name	Description
System.Int32	tabId	The tab id.
PortalSettings	portalSettings	The portal settings.

Returns

Type	Description
System.Boolean	true if the page was successfully deleted, otherwise false.

UpdateTab(TabInfo)

Updates the tab to database.

Declaration

void UpdateTab(TabInfo updatedTab)

Parameters

Type	Name	Description
TabInfo	updatedTab	The updated tab.

UpdateTabSetting(Int32, String, String)

Adds or updates a tab's setting value.

Declaration

void UpdateTabSetting(int tabId, string settingName, string settingValue)

Parameters

Type	Name	Description
System.Int32	tabId	ID of the tab to update.
System.String	settingName	name of the setting property.
System.String	settingValue	value of the setting (String).

Remarks

empty SettingValue will remove the setting, if not preserveIfEmpty is true.

UpdateTranslationStatus(TabInfo, Boolean)

Updates the translation status.

Declaration

void UpdateTranslationStatus(TabInfo localizedTab, bool isTranslated)

Parameters

Type	Name	Description
TabInfo	localizedTab	The localized tab.
System.Boolean	isTranslated	if set to true means the tab has already been translated.

Extension Methods

JsonExtensionsWeb.ToJson(Object)