Class TabController
Inheritance
TabController
Assembly: DotNetNuke.dll
Syntax
public class TabController : ServiceLocator<ITabController, TabController>, ITabController
Constructors
TabController()
Declaration
Properties
CurrentPage
Declaration
public static TabInfo CurrentPage { get; }
Property Value
Methods
AddMissingLanguages(int, int)
Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use AddMissingLanguagesWithWarnings. Scheduled for removal in v11.0.0.")]
public void AddMissingLanguages(int portalId, int tabId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
tabId |
|
AddMissingLanguagesWithWarnings(int, int)
Declaration
public bool AddMissingLanguagesWithWarnings(int portalId, int tabId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
tabId |
|
Returns
AddTab(TabInfo)
Declaration
public int AddTab(TabInfo tab)
Parameters
Returns
AddTab(TabInfo, bool)
Declaration
public int AddTab(TabInfo tab, bool includeAllTabsModules)
Parameters
Type |
Name |
Description |
TabInfo |
tab |
|
bool |
includeAllTabsModules |
|
Returns
AddTabAfter(TabInfo, int)
Declaration
public int AddTabAfter(TabInfo tab, int afterTabId)
Parameters
Returns
AddTabBefore(TabInfo, int)
Declaration
public int AddTabBefore(TabInfo objTab, int beforeTabId)
Parameters
Type |
Name |
Description |
TabInfo |
objTab |
|
int |
beforeTabId |
|
Returns
ClearCache(int)
Declaration
public void ClearCache(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
ConvertTabToNeutralLanguage(int, int, string, bool)
Declaration
public void ConvertTabToNeutralLanguage(int portalId, int tabId, string cultureCode, bool clearCache)
Parameters
CopyDesignToChildren(TabInfo, string, string)
Declaration
public static void CopyDesignToChildren(TabInfo parentTab, string skinSrc, string containerSrc)
Parameters
CopyDesignToChildren(TabInfo, string, string, string)
Declaration
public static void CopyDesignToChildren(TabInfo parentTab, string skinSrc, string containerSrc, string cultureCode)
Parameters
CopyPermissionsToChildren(TabInfo, TabPermissionCollection)
Declaration
public static void CopyPermissionsToChildren(TabInfo parentTab, TabPermissionCollection newPermissions)
Parameters
CreateContentItem(TabInfo)
Declaration
public void CreateContentItem(TabInfo tab)
Parameters
CreateLocalizedCopies(TabInfo)
Declaration
public void CreateLocalizedCopies(TabInfo originalTab)
Parameters
Type |
Name |
Description |
TabInfo |
originalTab |
|
CreateLocalizedCopy(TabInfo, Locale, bool)
Declaration
public void CreateLocalizedCopy(TabInfo originalTab, Locale locale, bool clearCache)
Parameters
DeleteTab(int, int)
Declaration
public void DeleteTab(int tabId, int portalId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
DeleteTab(int, int, bool)
Declaration
public void DeleteTab(int tabId, int portalId, bool deleteDescendants)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
bool |
deleteDescendants |
|
DeleteTabSetting(int, string)
Declaration
public void DeleteTabSetting(int tabId, string settingName)
Parameters
Type |
Name |
Description |
int |
tabId |
|
string |
settingName |
|
DeleteTabSettings(int)
Declaration
public void DeleteTabSettings(int tabId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
DeleteTabUrl(TabUrlInfo, int, bool)
Declaration
public void DeleteTabUrl(TabUrlInfo tabUrl, int portalId, bool clearCache)
Parameters
DeleteTranslatedTabs(int, string, bool)
Declaration
public bool DeleteTranslatedTabs(int portalId, string cultureCode, bool clearCache)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
bool |
clearCache |
|
Returns
DeserializePanes(XmlNode, int, int, PortalTemplateModuleAction, Hashtable)
Declaration
public static void DeserializePanes(XmlNode nodePanes, int portalId, int tabId, PortalTemplateModuleAction mergeTabs, Hashtable hModules)
Parameters
DeserializeTab(XmlNode, TabInfo, Hashtable, int, bool, PortalTemplateModuleAction, Hashtable)
Declaration
public static TabInfo DeserializeTab(XmlNode tabNode, TabInfo tab, Hashtable tabs, int portalId, bool isAdminTemplate, PortalTemplateModuleAction mergeTabs, Hashtable modules)
Parameters
Returns
DeserializeTab(XmlNode, TabInfo, int, PortalTemplateModuleAction)
Declaration
public static TabInfo DeserializeTab(XmlNode tabNode, TabInfo tab, int portalId, PortalTemplateModuleAction mergeTabs)
Parameters
Returns
EnsureNeutralLanguage(int, string, bool)
Declaration
public void EnsureNeutralLanguage(int portalId, string cultureCode, bool clearCache)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
bool |
clearCache |
|
GetAliasSkins(int, int)
Declaration
public List<TabAliasSkinInfo> GetAliasSkins(int tabId, int portalId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
Returns
GetCustomAliases(int, int)
Declaration
public Dictionary<string, string> GetCustomAliases(int tabId, int portalId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
Returns
GetFactory()
Declaration
protected override Func<ITabController> GetFactory()
Returns
Overrides
GetPortalTabs(List<TabInfo>, int, bool, string, bool, bool, bool, bool, bool)
Declaration
public static List<TabInfo> GetPortalTabs(List<TabInfo> tabs, int excludeTabId, bool includeNoneSpecified, string noneSpecifiedText, bool includeHidden, bool includeDeleted, bool includeURL, bool checkViewPermisison, bool checkEditPermission)
Parameters
Returns
GetPortalTabs(List<TabInfo>, int, bool, string, bool, bool, bool, bool, bool, bool)
Declaration
public static List<TabInfo> GetPortalTabs(List<TabInfo> tabs, int excludeTabId, bool includeNoneSpecified, string noneSpecifiedText, bool includeHidden, bool includeDeleted, bool includeURL, bool checkViewPermisison, bool checkEditPermission, bool includeDeletedChildren)
Parameters
Type |
Name |
Description |
List<TabInfo> |
tabs |
|
int |
excludeTabId |
|
bool |
includeNoneSpecified |
|
string |
noneSpecifiedText |
|
bool |
includeHidden |
|
bool |
includeDeleted |
|
bool |
includeURL |
|
bool |
checkViewPermisison |
|
bool |
checkEditPermission |
|
bool |
includeDeletedChildren |
|
Returns
GetPortalTabs(int, int, bool, bool)
Declaration
public static List<TabInfo> GetPortalTabs(int portalId, int excludeTabId, bool includeNoneSpecified, bool includeHidden)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
excludeTabId |
|
bool |
includeNoneSpecified |
|
bool |
includeHidden |
|
Returns
GetPortalTabs(int, int, bool, bool, bool, bool)
Declaration
public static List<TabInfo> GetPortalTabs(int portalId, int excludeTabId, bool includeNoneSpecified, bool includeHidden, bool includeDeleted, bool includeURL)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
excludeTabId |
|
bool |
includeNoneSpecified |
|
bool |
includeHidden |
|
bool |
includeDeleted |
|
bool |
includeURL |
|
Returns
GetPortalTabs(int, int, bool, string, bool, bool, bool, bool, bool)
Declaration
public static List<TabInfo> GetPortalTabs(int portalId, int excludeTabId, bool includeNoneSpecified, string noneSpecifiedText, bool includeHidden, bool includeDeleted, bool includeURL, bool checkViewPermisison, bool checkEditPermission)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
excludeTabId |
|
bool |
includeNoneSpecified |
|
string |
noneSpecifiedText |
|
bool |
includeHidden |
|
bool |
includeDeleted |
|
bool |
includeURL |
|
bool |
checkViewPermisison |
|
bool |
checkEditPermission |
|
Returns
GetTab(int, int)
Declaration
public TabInfo GetTab(int tabId, int portalId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
Returns
GetTab(int, int, bool)
Declaration
public TabInfo GetTab(int tabId, int portalId, bool ignoreCache)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
bool |
ignoreCache |
|
Returns
GetTabByCulture(int, int, Locale)
Declaration
public TabInfo GetTabByCulture(int tabId, int portalId, Locale locale)
Parameters
Returns
GetTabByName(string, int)
Declaration
public TabInfo GetTabByName(string tabName, int portalId)
Parameters
Type |
Name |
Description |
string |
tabName |
|
int |
portalId |
|
Returns
GetTabByName(string, int, int)
Declaration
public TabInfo GetTabByName(string tabName, int portalId, int parentId)
Parameters
Type |
Name |
Description |
string |
tabName |
|
int |
portalId |
|
int |
parentId |
|
Returns
GetTabByTabPath(int, string, string)
Declaration
public static int GetTabByTabPath(int portalId, string tabPath, string cultureCode)
Parameters
Returns
GetTabPathDictionary(int, string)
Declaration
public static Dictionary<string, int> GetTabPathDictionary(int portalId, string cultureCode)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
Returns
GetTabSettings(int)
Declaration
public Hashtable GetTabSettings(int tabId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
Returns
GetTabUrls(int, int)
Declaration
public List<TabUrlInfo> GetTabUrls(int tabId, int portalId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
Returns
GetTabsByModuleID(int)
Declaration
public IDictionary<int, TabInfo> GetTabsByModuleID(int moduleID)
Parameters
Type |
Name |
Description |
int |
moduleID |
|
Returns
GetTabsByPackageID(int, int, bool)
Declaration
public IDictionary<int, TabInfo> GetTabsByPackageID(int portalID, int packageID, bool forHost)
Parameters
Type |
Name |
Description |
int |
portalID |
|
int |
packageID |
|
bool |
forHost |
|
Returns
GetTabsByParent(int, int)
Declaration
public static List<TabInfo> GetTabsByParent(int parentId, int portalId)
Parameters
Type |
Name |
Description |
int |
parentId |
|
int |
portalId |
|
Returns
GetTabsByPortal(int)
Declaration
public TabCollection GetTabsByPortal(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GetTabsBySortOrder(int)
Declaration
public static List<TabInfo> GetTabsBySortOrder(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GetTabsBySortOrder(int, string, bool)
Declaration
public static List<TabInfo> GetTabsBySortOrder(int portalId, string cultureCode, bool includeNeutral)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
cultureCode |
|
bool |
includeNeutral |
|
Returns
GetTabsByTabModuleID(int)
Declaration
public IDictionary<int, TabInfo> GetTabsByTabModuleID(int tabModuleId)
Parameters
Type |
Name |
Description |
int |
tabModuleId |
|
Returns
GetUserTabsByPortal(int)
Declaration
public TabCollection GetUserTabsByPortal(int portalId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
Returns
GiveTranslatorRoleEditRights(TabInfo, Dictionary<int, UserInfo>)
Declaration
public void GiveTranslatorRoleEditRights(TabInfo localizedTab, Dictionary<int, UserInfo> users)
Parameters
HasMissingLanguages(int, int)
Declaration
public bool HasMissingLanguages(int portalId, int tabId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
tabId |
|
Returns
IsDuplicateWithPortalAlias(int, string)
Declaration
public static bool IsDuplicateWithPortalAlias(int portalId, string tabPath)
Parameters
Type |
Name |
Description |
int |
portalId |
|
string |
tabPath |
|
Returns
IsHostOrAdminPage(TabInfo)
Declaration
public bool IsHostOrAdminPage(TabInfo tab)
Parameters
Returns
IsSpecialTab(int, PortalSettings)
Declaration
public static bool IsSpecialTab(int tabId, PortalSettings portalSettings)
Parameters
Returns
IsSpecialTab(int, int)
Declaration
public static bool IsSpecialTab(int tabId, int portalId)
Parameters
Type |
Name |
Description |
int |
tabId |
|
int |
portalId |
|
Returns
IsTabPublished(TabInfo)
Declaration
public bool IsTabPublished(TabInfo publishTab)
Parameters
Type |
Name |
Description |
TabInfo |
publishTab |
|
Returns
IsValidTabName(string, out string)
Declaration
public static bool IsValidTabName(string tabName, out string invalidType)
Parameters
Returns
LocalizeTab(TabInfo, Locale)
Declaration
public void LocalizeTab(TabInfo originalTab, Locale locale)
Parameters
LocalizeTab(TabInfo, Locale, bool)
Declaration
public void LocalizeTab(TabInfo originalTab, Locale locale, bool clearCache)
Parameters
MarkAsPublished(TabInfo)
Declaration
public void MarkAsPublished(TabInfo tab)
Parameters
MoveTabAfter(TabInfo, int)
Declaration
public void MoveTabAfter(TabInfo tab, int afterTabId)
Parameters
MoveTabBefore(TabInfo, int)
Declaration
public void MoveTabBefore(TabInfo tab, int beforeTabId)
Parameters
MoveTabToParent(TabInfo, int)
Declaration
public void MoveTabToParent(TabInfo tab, int parentId)
Parameters
PopulateBreadCrumbs(ref TabInfo)
Declaration
public void PopulateBreadCrumbs(ref TabInfo tab)
Parameters
PopulateBreadCrumbs(int, ref ArrayList, int)
Declaration
public void PopulateBreadCrumbs(int portalID, ref ArrayList breadCrumbs, int tabID)
Parameters
PublishTab(TabInfo)
Declaration
public void PublishTab(TabInfo publishTab)
Parameters
Type |
Name |
Description |
TabInfo |
publishTab |
|
PublishTabs(List<TabInfo>)
Declaration
public void PublishTabs(List<TabInfo> tabs)
Parameters
RefreshCache(int, int)
Declaration
public void RefreshCache(int portalId, int tabId)
Parameters
Type |
Name |
Description |
int |
portalId |
|
int |
tabId |
|
RestoreTab(TabInfo, PortalSettings)
Declaration
public void RestoreTab(TabInfo tab, PortalSettings portalSettings)
Parameters
SaveTabUrl(TabUrlInfo, int, bool)
Declaration
public void SaveTabUrl(TabUrlInfo tabUrl, int portalId, bool clearCache)
Parameters
SerializeTab(XmlDocument, TabInfo, bool)
Declaration
public static XmlNode SerializeTab(XmlDocument tabXml, TabInfo objTab, bool includeContent)
Parameters
Returns
SerializeTab(XmlDocument, Hashtable, TabInfo, PortalInfo, bool)
Declaration
public static XmlNode SerializeTab(XmlDocument tabXml, Hashtable tabs, TabInfo tab, PortalInfo portal, bool includeContent)
Parameters
Returns
SoftDeleteTab(int, PortalSettings)
Declaration
public bool SoftDeleteTab(int tabId, PortalSettings portalSettings)
Parameters
Returns
UpdateTab(TabInfo)
Declaration
public void UpdateTab(TabInfo updatedTab)
Parameters
Type |
Name |
Description |
TabInfo |
updatedTab |
|
UpdateTabSetting(int, string, string)
Declaration
public void UpdateTabSetting(int tabId, string settingName, string settingValue)
Parameters
UpdateTranslationStatus(TabInfo, bool)
Declaration
public void UpdateTranslationStatus(TabInfo localizedTab, bool isTranslated)
Parameters
Type |
Name |
Description |
TabInfo |
localizedTab |
|
bool |
isTranslated |
|
Implements
Extension Methods