Interface ITabController

Namespace: DotNetNuke.Entities.Tabs
Assembly: DotNetNuke.dll
Syntax
public interface ITabController

Methods

AddMissingLanguages(int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use AddMissingLanguagesWithWarnings. Scheduled removal in v11.0.0.")]
void AddMissingLanguages(int portalId, int tabId)
Parameters
Type Name Description
int portalId
int tabId

AddMissingLanguagesWithWarnings(int, int)

Declaration
bool AddMissingLanguagesWithWarnings(int portalId, int tabId)
Parameters
Type Name Description
int portalId
int tabId
Returns
Type Description
bool

AddTab(TabInfo)

Declaration
int AddTab(TabInfo tab)
Parameters
Type Name Description
TabInfo tab
Returns
Type Description
int

AddTab(TabInfo, bool)

Declaration
int AddTab(TabInfo tab, bool includeAllTabsModules)
Parameters
Type Name Description
TabInfo tab
bool includeAllTabsModules
Returns
Type Description
int

AddTabAfter(TabInfo, int)

Declaration
int AddTabAfter(TabInfo tab, int afterTabId)
Parameters
Type Name Description
TabInfo tab
int afterTabId
Returns
Type Description
int

AddTabBefore(TabInfo, int)

Declaration
int AddTabBefore(TabInfo objTab, int beforeTabId)
Parameters
Type Name Description
TabInfo objTab
int beforeTabId
Returns
Type Description
int

ClearCache(int)

Declaration
void ClearCache(int portalId)
Parameters
Type Name Description
int portalId

ConvertTabToNeutralLanguage(int, int, string, bool)

Declaration
void ConvertTabToNeutralLanguage(int portalId, int tabId, string cultureCode, bool clearCache)
Parameters
Type Name Description
int portalId
int tabId
string cultureCode
bool clearCache

CreateContentItem(TabInfo)

Declaration
void CreateContentItem(TabInfo tab)
Parameters
Type Name Description
TabInfo tab

CreateLocalizedCopies(TabInfo)

Declaration
void CreateLocalizedCopies(TabInfo originalTab)
Parameters
Type Name Description
TabInfo originalTab

CreateLocalizedCopy(TabInfo, Locale, bool)

Declaration
void CreateLocalizedCopy(TabInfo originalTab, Locale locale, bool clearCache)
Parameters
Type Name Description
TabInfo originalTab
Locale locale
bool clearCache

DeleteTab(int, int)

Declaration
void DeleteTab(int tabId, int portalId)
Parameters
Type Name Description
int tabId
int portalId

DeleteTab(int, int, bool)

Declaration
void DeleteTab(int tabId, int portalId, bool deleteDescendants)
Parameters
Type Name Description
int tabId
int portalId
bool deleteDescendants

DeleteTabSetting(int, string)

Declaration
void DeleteTabSetting(int tabId, string settingName)
Parameters
Type Name Description
int tabId
string settingName

DeleteTabSettings(int)

Declaration
void DeleteTabSettings(int tabId)
Parameters
Type Name Description
int tabId

DeleteTabUrl(TabUrlInfo, int, bool)

Declaration
void DeleteTabUrl(TabUrlInfo tabUrl, int portalId, bool clearCache)
Parameters
Type Name Description
TabUrlInfo tabUrl
int portalId
bool clearCache

DeleteTranslatedTabs(int, string, bool)

Declaration
bool DeleteTranslatedTabs(int portalId, string cultureCode, bool clearCache)
Parameters
Type Name Description
int portalId
string cultureCode
bool clearCache
Returns
Type Description
bool

EnsureNeutralLanguage(int, string, bool)

Declaration
void EnsureNeutralLanguage(int portalId, string cultureCode, bool clearCache)
Parameters
Type Name Description
int portalId
string cultureCode
bool clearCache

GetAliasSkins(int, int)

Declaration
List<TabAliasSkinInfo> GetAliasSkins(int tabId, int portalId)
Parameters
Type Name Description
int tabId
int portalId
Returns
Type Description
List<TabAliasSkinInfo>

GetCustomAliases(int, int)

Declaration
Dictionary<string, string> GetCustomAliases(int tabId, int portalId)
Parameters
Type Name Description
int tabId
int portalId
Returns
Type Description
Dictionary<string, string>

GetTab(int, int)

Declaration
TabInfo GetTab(int tabId, int portalId)
Parameters
Type Name Description
int tabId
int portalId
Returns
Type Description
TabInfo

GetTab(int, int, bool)

Declaration
TabInfo GetTab(int tabId, int portalId, bool ignoreCache)
Parameters
Type Name Description
int tabId
int portalId
bool ignoreCache
Returns
Type Description
TabInfo

GetTabByCulture(int, int, Locale)

Declaration
TabInfo GetTabByCulture(int tabId, int portalId, Locale locale)
Parameters
Type Name Description
int tabId
int portalId
Locale locale
Returns
Type Description
TabInfo

GetTabByName(string, int)

Declaration
TabInfo GetTabByName(string tabName, int portalId)
Parameters
Type Name Description
string tabName
int portalId
Returns
Type Description
TabInfo

GetTabByName(string, int, int)

Declaration
TabInfo GetTabByName(string tabName, int portalId, int parentId)
Parameters
Type Name Description
string tabName
int portalId
int parentId
Returns
Type Description
TabInfo

GetTabSettings(int)

Declaration
Hashtable GetTabSettings(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
Hashtable

GetTabUrls(int, int)

Declaration
List<TabUrlInfo> GetTabUrls(int tabId, int portalId)
Parameters
Type Name Description
int tabId
int portalId
Returns
Type Description
List<TabUrlInfo>

GetTabsByModuleID(int)

Declaration
IDictionary<int, TabInfo> GetTabsByModuleID(int moduleID)
Parameters
Type Name Description
int moduleID
Returns
Type Description
IDictionary<int, TabInfo>

GetTabsByPackageID(int, int, bool)

Declaration
IDictionary<int, TabInfo> GetTabsByPackageID(int portalID, int packageID, bool forHost)
Parameters
Type Name Description
int portalID
int packageID
bool forHost
Returns
Type Description
IDictionary<int, TabInfo>

GetTabsByPortal(int)

Declaration
TabCollection GetTabsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
TabCollection

GetTabsByTabModuleID(int)

Declaration
IDictionary<int, TabInfo> GetTabsByTabModuleID(int tabModuleId)
Parameters
Type Name Description
int tabModuleId
Returns
Type Description
IDictionary<int, TabInfo>

GetUserTabsByPortal(int)

Declaration
TabCollection GetUserTabsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
TabCollection

GiveTranslatorRoleEditRights(TabInfo, Dictionary<int, UserInfo>)

Declaration
void GiveTranslatorRoleEditRights(TabInfo localizedTab, Dictionary<int, UserInfo> users)
Parameters
Type Name Description
TabInfo localizedTab
Dictionary<int, UserInfo> users

HasMissingLanguages(int, int)

Declaration
bool HasMissingLanguages(int portalId, int tabId)
Parameters
Type Name Description
int portalId
int tabId
Returns
Type Description
bool

IsHostOrAdminPage(TabInfo)

Declaration
bool IsHostOrAdminPage(TabInfo tab)
Parameters
Type Name Description
TabInfo tab
Returns
Type Description
bool

IsTabPublished(TabInfo)

Declaration
bool IsTabPublished(TabInfo publishTab)
Parameters
Type Name Description
TabInfo publishTab
Returns
Type Description
bool

LocalizeTab(TabInfo, Locale)

Declaration
void LocalizeTab(TabInfo originalTab, Locale locale)
Parameters
Type Name Description
TabInfo originalTab
Locale locale

LocalizeTab(TabInfo, Locale, bool)

Declaration
void LocalizeTab(TabInfo originalTab, Locale locale, bool clearCache)
Parameters
Type Name Description
TabInfo originalTab
Locale locale
bool clearCache

MarkAsPublished(TabInfo)

Declaration
void MarkAsPublished(TabInfo tab)
Parameters
Type Name Description
TabInfo tab

MoveTabAfter(TabInfo, int)

Declaration
void MoveTabAfter(TabInfo tab, int afterTabId)
Parameters
Type Name Description
TabInfo tab
int afterTabId

MoveTabBefore(TabInfo, int)

Declaration
void MoveTabBefore(TabInfo tab, int beforeTabId)
Parameters
Type Name Description
TabInfo tab
int beforeTabId

MoveTabToParent(TabInfo, int)

Declaration
void MoveTabToParent(TabInfo tab, int parentId)
Parameters
Type Name Description
TabInfo tab
int parentId

PopulateBreadCrumbs(ref TabInfo)

Declaration
void PopulateBreadCrumbs(ref TabInfo tab)
Parameters
Type Name Description
TabInfo tab

PopulateBreadCrumbs(int, ref ArrayList, int)

Declaration
void PopulateBreadCrumbs(int portalID, ref ArrayList breadCrumbs, int tabID)
Parameters
Type Name Description
int portalID
ArrayList breadCrumbs
int tabID

PublishTab(TabInfo)

Declaration
void PublishTab(TabInfo publishTab)
Parameters
Type Name Description
TabInfo publishTab

PublishTabs(List<TabInfo>)

Declaration
void PublishTabs(List<TabInfo> tabs)
Parameters
Type Name Description
List<TabInfo> tabs

RefreshCache(int, int)

Declaration
void RefreshCache(int portalId, int tabId)
Parameters
Type Name Description
int portalId
int tabId

RestoreTab(TabInfo, PortalSettings)

Declaration
void RestoreTab(TabInfo tab, PortalSettings portalSettings)
Parameters
Type Name Description
TabInfo tab
PortalSettings portalSettings

SaveTabUrl(TabUrlInfo, int, bool)

Declaration
void SaveTabUrl(TabUrlInfo tabUrl, int portalId, bool clearCache)
Parameters
Type Name Description
TabUrlInfo tabUrl
int portalId
bool clearCache

SoftDeleteTab(int, PortalSettings)

Declaration
bool SoftDeleteTab(int tabId, PortalSettings portalSettings)
Parameters
Type Name Description
int tabId
PortalSettings portalSettings
Returns
Type Description
bool

UpdateTab(TabInfo)

Declaration
void UpdateTab(TabInfo updatedTab)
Parameters
Type Name Description
TabInfo updatedTab

UpdateTabSetting(int, string, string)

Declaration
void UpdateTabSetting(int tabId, string settingName, string settingValue)
Parameters
Type Name Description
int tabId
string settingName
string settingValue

UpdateTranslationStatus(TabInfo, bool)

Declaration
void UpdateTranslationStatus(TabInfo localizedTab, bool isTranslated)
Parameters
Type Name Description
TabInfo localizedTab
bool isTranslated

Extension Methods