Class TabController

Inheritance

object

ServiceLocator<ITabController, TabController>

TabController

Implements

ITabController

Inherited Members

ServiceLocator<ITabController, TabController>.SetTestableInstance(ITabController)

ServiceLocator<ITabController, TabController>.ClearInstance()

ServiceLocator<ITabController, TabController>.GetFactory()

ServiceLocator<ITabController, TabController>.Instance

ServiceLocator<ITabController, TabController>.Factory

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Entities.Tabs

Assembly: DotNetNuke.dll

Syntax

public class TabController : ServiceLocator<ITabController, TabController>, ITabController

Constructors

TabController()

Declaration

public TabController()

Properties

CurrentPage

Declaration

public static TabInfo CurrentPage { get; }

Property Value

Type	Description
TabInfo

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

Type	Description
bool

AddTab(TabInfo)

Declaration

public int AddTab(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab

Returns

Type	Description
int

AddTab(TabInfo, bool)

Declaration

public int AddTab(TabInfo tab, bool includeAllTabsModules)

Parameters

Type	Name	Description
TabInfo	tab
bool	includeAllTabsModules

Returns

Type	Description
int

AddTabAfter(TabInfo, int)

Declaration

public int AddTabAfter(TabInfo tab, int afterTabId)

Parameters

Type	Name	Description
TabInfo	tab
int	afterTabId

Returns

Type	Description
int

AddTabBefore(TabInfo, int)

Declaration

public int AddTabBefore(TabInfo objTab, int beforeTabId)

Parameters

Type	Name	Description
TabInfo	objTab
int	beforeTabId

Returns

Type	Description
int

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

Type	Name	Description
int	portalId
int	tabId
string	cultureCode
bool	clearCache

CopyDesignToChildren(TabInfo, string, string)

Declaration

public static void CopyDesignToChildren(TabInfo parentTab, string skinSrc, string containerSrc)

Parameters

Type	Name	Description
TabInfo	parentTab
string	skinSrc
string	containerSrc

CopyDesignToChildren(TabInfo, string, string, string)

Declaration

public static void CopyDesignToChildren(TabInfo parentTab, string skinSrc, string containerSrc, string cultureCode)

Parameters

Type	Name	Description
TabInfo	parentTab
string	skinSrc
string	containerSrc
string	cultureCode

CopyPermissionsToChildren(TabInfo, TabPermissionCollection)

Declaration

public static void CopyPermissionsToChildren(TabInfo parentTab, TabPermissionCollection newPermissions)

Parameters

Type	Name	Description
TabInfo	parentTab
TabPermissionCollection	newPermissions

CreateContentItem(TabInfo)

Declaration

public void CreateContentItem(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab

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

Type	Name	Description
TabInfo	originalTab
Locale	locale
bool	clearCache

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

Type	Name	Description
TabUrlInfo	tabUrl
int	portalId
bool	clearCache

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

Type	Description
bool

DeserializePanes(IBusinessControllerProvider, XmlNode, int, int, PortalTemplateModuleAction, Hashtable)

Declaration

public static void DeserializePanes(IBusinessControllerProvider businessControllerProvider, XmlNode nodePanes, int portalId, int tabId, PortalTemplateModuleAction mergeTabs, Hashtable hModules)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlNode	nodePanes
int	portalId
int	tabId
PortalTemplateModuleAction	mergeTabs
Hashtable	hModules

DeserializePanes(XmlNode, int, int, PortalTemplateModuleAction, Hashtable)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static void DeserializePanes(XmlNode nodePanes, int portalId, int tabId, PortalTemplateModuleAction mergeTabs, Hashtable hModules)

Parameters

Type	Name	Description
XmlNode	nodePanes
int	portalId
int	tabId
PortalTemplateModuleAction	mergeTabs
Hashtable	hModules

DeserializeTab(IBusinessControllerProvider, XmlNode, TabInfo, Hashtable, int, bool, PortalTemplateModuleAction, Hashtable)

Declaration

public static TabInfo DeserializeTab(IBusinessControllerProvider businessControllerProvider, XmlNode tabNode, TabInfo tab, Hashtable tabs, int portalId, bool isAdminTemplate, PortalTemplateModuleAction mergeTabs, Hashtable modules)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlNode	tabNode
TabInfo	tab
Hashtable	tabs
int	portalId
bool	isAdminTemplate
PortalTemplateModuleAction	mergeTabs
Hashtable	modules

Returns

Type	Description
TabInfo

DeserializeTab(IBusinessControllerProvider, XmlNode, TabInfo, int, PortalTemplateModuleAction)

Declaration

public static TabInfo DeserializeTab(IBusinessControllerProvider businessControllerProvider, XmlNode tabNode, TabInfo tab, int portalId, PortalTemplateModuleAction mergeTabs)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlNode	tabNode
TabInfo	tab
int	portalId
PortalTemplateModuleAction	mergeTabs

Returns

Type	Description
TabInfo

DeserializeTab(XmlNode, TabInfo, Hashtable, int, bool, PortalTemplateModuleAction, Hashtable)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static TabInfo DeserializeTab(XmlNode tabNode, TabInfo tab, Hashtable tabs, int portalId, bool isAdminTemplate, PortalTemplateModuleAction mergeTabs, Hashtable modules)

Parameters

Type	Name	Description
XmlNode	tabNode
TabInfo	tab
Hashtable	tabs
int	portalId
bool	isAdminTemplate
PortalTemplateModuleAction	mergeTabs
Hashtable	modules

Returns

Type	Description
TabInfo

DeserializeTab(XmlNode, TabInfo, int, PortalTemplateModuleAction)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static TabInfo DeserializeTab(XmlNode tabNode, TabInfo tab, int portalId, PortalTemplateModuleAction mergeTabs)

Parameters

Type	Name	Description
XmlNode	tabNode
TabInfo	tab
int	portalId
PortalTemplateModuleAction	mergeTabs

Returns

Type	Description
TabInfo

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

Type	Description
List<TabAliasSkinInfo>

GetCustomAliases(int, int)

Declaration

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

Parameters

Type	Name	Description
int	tabId
int	portalId

Returns

Type	Description
Dictionary<string, string>

GetFactory()

Declaration

protected override Func<ITabController> GetFactory()

Returns

Type	Description
Func<ITabController>

Overrides

ServiceLocator<ITabController, TabController>.GetFactory()

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

Type	Name	Description
List<TabInfo>	tabs
int	excludeTabId
bool	includeNoneSpecified
string	noneSpecifiedText
bool	includeHidden
bool	includeDeleted
bool	includeURL
bool	checkViewPermisison
bool	checkEditPermission

Returns

Type	Description
List<TabInfo>

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

Type	Description
List<TabInfo>

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

Type	Description
List<TabInfo>

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

Type	Description
List<TabInfo>

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

Type	Description
List<TabInfo>

GetTab(int, int)

Declaration

public TabInfo GetTab(int tabId, int portalId)

Parameters

Type	Name	Description
int	tabId
int	portalId

Returns

Type	Description
TabInfo

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

Type	Description
TabInfo

GetTabByCulture(int, int, Locale)

Declaration

public 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

public TabInfo GetTabByName(string tabName, int portalId)

Parameters

Type	Name	Description
string	tabName
int	portalId

Returns

Type	Description
TabInfo

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

Type	Description
TabInfo

GetTabByTabPath(int, string, string)

Declaration

public static int GetTabByTabPath(int portalId, string tabPath, string cultureCode)

Parameters

Type	Name	Description
int	portalId
string	tabPath
string	cultureCode

Returns

Type	Description
int

GetTabPathDictionary(int, string)

Declaration

public static Dictionary<string, int> GetTabPathDictionary(int portalId, string cultureCode)

Parameters

Type	Name	Description
int	portalId
string	cultureCode

Returns

Type	Description
Dictionary<string, int>

GetTabSettings(int)

Declaration

public Hashtable GetTabSettings(int tabId)

Parameters

Type	Name	Description
int	tabId

Returns

Type	Description
Hashtable

GetTabUrls(int, int)

Declaration

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

Parameters

Type	Name	Description
int	tabId
int	portalId

Returns

Type	Description
List<TabUrlInfo>

GetTabsByModuleID(int)

Declaration

public IDictionary<int, TabInfo> GetTabsByModuleID(int moduleID)

Parameters

Type	Name	Description
int	moduleID

Returns

Type	Description
IDictionary<int, TabInfo>

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

Type	Description
IDictionary<int, TabInfo>

GetTabsByParent(int, int)

Declaration

public static List<TabInfo> GetTabsByParent(int parentId, int portalId)

Parameters

Type	Name	Description
int	parentId
int	portalId

Returns

Type	Description
List<TabInfo>

GetTabsByPortal(int)

Declaration

public TabCollection GetTabsByPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
TabCollection

GetTabsBySortOrder(int)

Declaration

public static List<TabInfo> GetTabsBySortOrder(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
List<TabInfo>

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

Type	Description
List<TabInfo>

GetTabsByTabModuleID(int)

Declaration

public IDictionary<int, TabInfo> GetTabsByTabModuleID(int tabModuleId)

Parameters

Type	Name	Description
int	tabModuleId

Returns

Type	Description
IDictionary<int, TabInfo>

GetUserTabsByPortal(int)

Declaration

public TabCollection GetUserTabsByPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
TabCollection

GiveTranslatorRoleEditRights(TabInfo, Dictionary<int, UserInfo>)

Declaration

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

Parameters

Type	Name	Description
TabInfo	localizedTab
Dictionary<int, UserInfo>	users

HasMissingLanguages(int, int)

Declaration

public bool HasMissingLanguages(int portalId, int tabId)

Parameters

Type	Name	Description
int	portalId
int	tabId

Returns

Type	Description
bool

IsDuplicateWithPortalAlias(int, string)

Declaration

public static bool IsDuplicateWithPortalAlias(int portalId, string tabPath)

Parameters

Type	Name	Description
int	portalId
string	tabPath

Returns

Type	Description
bool

IsHostOrAdminPage(TabInfo)

Declaration

public bool IsHostOrAdminPage(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab

Returns

Type	Description
bool

IsSpecialTab(int, PortalSettings)

Declaration

public static bool IsSpecialTab(int tabId, PortalSettings portalSettings)

Parameters

Type	Name	Description
int	tabId
PortalSettings	portalSettings

Returns

Type	Description
bool

IsSpecialTab(int, int)

Declaration

public static bool IsSpecialTab(int tabId, int portalId)

Parameters

Type	Name	Description
int	tabId
int	portalId

Returns

Type	Description
bool

IsTabPublished(TabInfo)

Declaration

public bool IsTabPublished(TabInfo publishTab)

Parameters

Type	Name	Description
TabInfo	publishTab

Returns

Type	Description
bool

IsValidTabName(string, out string)

Declaration

public static bool IsValidTabName(string tabName, out string invalidType)

Parameters

Type	Name	Description
string	tabName
string	invalidType

Returns

Type	Description
bool

LocalizeTab(TabInfo, Locale)

Declaration

public void LocalizeTab(TabInfo originalTab, Locale locale)

Parameters

Type	Name	Description
TabInfo	originalTab
Locale	locale

LocalizeTab(TabInfo, Locale, bool)

Declaration

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

Parameters

Type	Name	Description
TabInfo	originalTab
Locale	locale
bool	clearCache

MarkAsPublished(TabInfo)

Declaration

public void MarkAsPublished(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab

MoveTabAfter(TabInfo, int)

Declaration

public void MoveTabAfter(TabInfo tab, int afterTabId)

Parameters

Type	Name	Description
TabInfo	tab
int	afterTabId

MoveTabBefore(TabInfo, int)

Declaration

public void MoveTabBefore(TabInfo tab, int beforeTabId)

Parameters

Type	Name	Description
TabInfo	tab
int	beforeTabId

MoveTabToParent(TabInfo, int)

Declaration

public void MoveTabToParent(TabInfo tab, int parentId)

Parameters

Type	Name	Description
TabInfo	tab
int	parentId

PopulateBreadCrumbs(ref TabInfo)

Declaration

public void PopulateBreadCrumbs(ref TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab

PopulateBreadCrumbs(int, ref ArrayList, int)

Declaration

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

Parameters

Type	Name	Description
int	portalID
ArrayList	breadCrumbs
int	tabID

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

Type	Name	Description
List<TabInfo>	tabs

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

Type	Name	Description
TabInfo	tab
PortalSettings	portalSettings

SaveTabUrl(TabUrlInfo, int, bool)

Declaration

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

Parameters

Type	Name	Description
TabUrlInfo	tabUrl
int	portalId
bool	clearCache

SerializeTab(IBusinessControllerProvider, XmlDocument, TabInfo, bool)

Declaration

public static XmlNode SerializeTab(IBusinessControllerProvider businessControllerProvider, XmlDocument tabXml, TabInfo objTab, bool includeContent)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlDocument	tabXml
TabInfo	objTab
bool	includeContent

Returns

Type	Description
XmlNode

SerializeTab(IBusinessControllerProvider, XmlDocument, Hashtable, TabInfo, PortalInfo, bool)

Declaration

public static XmlNode SerializeTab(IBusinessControllerProvider businessControllerProvider, XmlDocument tabXml, Hashtable tabs, TabInfo tab, PortalInfo portal, bool includeContent)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlDocument	tabXml
Hashtable	tabs
TabInfo	tab
PortalInfo	portal
bool	includeContent

Returns

Type	Description
XmlNode

SerializeTab(XmlDocument, TabInfo, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static XmlNode SerializeTab(XmlDocument tabXml, TabInfo objTab, bool includeContent)

Parameters

Type	Name	Description
XmlDocument	tabXml
TabInfo	objTab
bool	includeContent

Returns

Type	Description
XmlNode

SerializeTab(XmlDocument, Hashtable, TabInfo, PortalInfo, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static XmlNode SerializeTab(XmlDocument tabXml, Hashtable tabs, TabInfo tab, PortalInfo portal, bool includeContent)

Parameters

Type	Name	Description
XmlDocument	tabXml
Hashtable	tabs
TabInfo	tab
PortalInfo	portal
bool	includeContent

Returns

Type	Description
XmlNode

SoftDeleteTab(int, PortalSettings)

Declaration

public bool SoftDeleteTab(int tabId, PortalSettings portalSettings)

Parameters

Type	Name	Description
int	tabId
PortalSettings	portalSettings

Returns

Type	Description
bool

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

Type	Name	Description
int	tabId
string	settingName
string	settingValue

UpdateTranslationStatus(TabInfo, bool)

Declaration

public void UpdateTranslationStatus(TabInfo localizedTab, bool isTranslated)

Parameters

Type	Name	Description
TabInfo	localizedTab
bool	isTranslated

Implements

ITabController

Extension Methods

JsonExtensionsWeb.ToJson(object)