Class TabController

TabController provides all operation to tabinfo.

Inheritance

System.Object

ServiceLocator<ITabController, TabController>

TabController

Implements

ITabController

Inherited Members

ServiceLocator<ITabController, TabController>.Instance

ServiceLocator<ITabController, TabController>.Factory

ServiceLocator<ITabController, TabController>.SetTestableInstance(ITabController)

ServiceLocator<ITabController, TabController>.ClearInstance()

ServiceLocator<ITabController, TabController>.GetFactory()

Namespace: DotNetNuke.Entities.Tabs

Assembly: DotNetNuke.dll

Syntax

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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

Properties

CurrentPage

Gets the current page in current http request.

Declaration

public static TabInfo CurrentPage { get; }

Property Value

Type	Description
TabInfo	Current Page Info.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

Methods

AddMissingLanguages(Int32, Int32)

Adds localized copies of the page in all missing languages.

Declaration

public void AddMissingLanguages(int portalId, int tabId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

AddMissingLanguagesWithWarnings(Int32, Int32)

Adds localized copies of the page in all missing languages.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

AddTab(TabInfo, Boolean)

Adds a tab.

Declaration

public 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

public 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

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

AddTabBefore(TabInfo, Int32)

Adds a tab before the specified tab.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

ClearCache(Int32)

Clears tabs and portal cache for the specific portal.

Declaration

public void ClearCache(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

ConvertTabToNeutralLanguage(Int32, Int32, String, Boolean)

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

Declaration

public 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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CopyDesignToChildren(TabInfo, String, String, String)

Copies the design to children.

Declaration

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

Parameters

Type	Name	Description
TabInfo	parentTab	The parent tab.
System.String	skinSrc	The skin SRC.
System.String	containerSrc	The container SRC.
System.String	cultureCode	The culture code.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CopyDesignToChildren(TabInfo, String, String)

Copies the design to children.

Declaration

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

Parameters

Type	Name	Description
TabInfo	parentTab	The parent tab.
System.String	skinSrc	The skin SRC.
System.String	containerSrc	The container SRC.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CopyPermissionsToChildren(TabInfo, TabPermissionCollection)

Copies the permissions to children.

Declaration

public static void CopyPermissionsToChildren(TabInfo parentTab, TabPermissionCollection newPermissions)

Parameters

Type	Name	Description
TabInfo	parentTab	The parent tab.
TabPermissionCollection	newPermissions	The new permissions.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CreateContentItem(TabInfo)

Creates content item for the tab..

Declaration

public void CreateContentItem(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The updated tab.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CreateLocalizedCopies(TabInfo)

Creates the localized copies.

Declaration

public void CreateLocalizedCopies(TabInfo originalTab)

Parameters

Type	Name	Description
TabInfo	originalTab	The original tab.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CreateLocalizedCopy(TabInfo, Locale, Boolean)

Creates the localized copy.

Declaration

public 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?.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CreateLocalizedCopy(TabInfo, Locale)

TabController provides all operation to tabinfo.

Declaration

public void CreateLocalizedCopy(TabInfo originalTab, Locale locale)

Parameters

Type	Name	Description
TabInfo	originalTab
Locale	locale

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

CreateLocalizedCopy(List<TabInfo>, Locale)

TabController provides all operation to tabinfo.

Declaration

public void CreateLocalizedCopy(List<TabInfo> tabs, Locale locale)

Parameters

Type	Name	Description
List<TabInfo>	tabs
Locale	locale

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeleteTab(Int32, Int32, Boolean)

Deletes a tab permanently from the database.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeleteTab(Int32, Int32)

Deletes a tab permanently from the database.

Declaration

public 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

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeleteTabSettings(Int32)

Delete all Settings of a tab instance.

Declaration

public void DeleteTabSettings(int tabId)

Parameters

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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeleteTabUrl(TabUrlInfo, Int32, Boolean)

Delete a taburl.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

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

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeserializePanes(XmlNode, Int32, Int32, PortalTemplateModuleAction, Hashtable)

Processes all panes and modules in the template file.

Declaration

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

Parameters

Type	Name	Description
XmlNode	nodePanes	Template file node for the panes is current tab.
System.Int32	portalId	PortalId of the new portal.
System.Int32	tabId	Tab being processed.
PortalTemplateModuleAction	mergeTabs	Tabs need to merge.
Hashtable	hModules	Modules Hashtable.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeserializeTab(XmlNode, TabInfo, Hashtable, Int32, Boolean, PortalTemplateModuleAction, Hashtable)

Deserializes the tab.

Declaration

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

Parameters

Type	Name	Description
XmlNode	tabNode	The node tab.
TabInfo	tab	The obj tab.
Hashtable	tabs	The h tabs.
System.Int32	portalId	The portal id.
System.Boolean	isAdminTemplate	if set to true [is admin template].
PortalTemplateModuleAction	mergeTabs	The merge tabs.
Hashtable	modules	The h modules.

Returns

Type	Description
TabInfo	The deserialized TabInfo instance.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

DeserializeTab(XmlNode, TabInfo, Int32, PortalTemplateModuleAction)

Deserializes the tab.

Declaration

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

Parameters

Type	Name	Description
XmlNode	tabNode	The node tab.
TabInfo	tab	The obj tab.
System.Int32	portalId	The portal id.
PortalTemplateModuleAction	mergeTabs	The merge tabs.

Returns

Type	Description
TabInfo	The deserialized TabInfo instance.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

EnsureNeutralLanguage(Int32, String, Boolean)

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

Declaration

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

Parameters

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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetAliasSkins(Int32, Int32)

Get the list of skins per alias at tab level.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetAllTabs()

TabController provides all operation to tabinfo.

Declaration

public ArrayList GetAllTabs()

Returns

Type	Description
ArrayList

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetCultureTabList(Int32)

TabController provides all operation to tabinfo.

Declaration

public List<TabInfo> GetCultureTabList(int portalid)

Parameters

Type	Name	Description
System.Int32	portalid

Returns

Type	Description
List<TabInfo>

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetCustomAliases(Int32, Int32)

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

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetDefaultCultureTabList(Int32)

TabController provides all operation to tabinfo.

Declaration

public List<TabInfo> GetDefaultCultureTabList(int portalid)

Parameters

Type	Name	Description
System.Int32	portalid

Returns

Type	Description
List<TabInfo>

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetFactory()

Gets the service locator factory.

Declaration

protected override Func<ITabController> GetFactory()

Returns

Type	Description
Func<ITabController>	A factory function.

Overrides

DotNetNuke.Framework.ServiceLocator<DotNetNuke.Entities.Tabs.ITabController, DotNetNuke.Entities.Tabs.TabController>.GetFactory()

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetPortalTabs(List<TabInfo>, Int32, Boolean, String, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

Gets the portal tabs.

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	The tabs.
System.Int32	excludeTabId	The exclude tab id.
System.Boolean	includeNoneSpecified	if set to true [include none specified].
System.String	noneSpecifiedText	The none specified text.
System.Boolean	includeHidden	if set to true [include hidden].
System.Boolean	includeDeleted	if set to true [include deleted].
System.Boolean	includeURL	if set to true [include URL].
System.Boolean	checkViewPermisison	if set to true [check view permission].
System.Boolean	checkEditPermission	if set to true [check edit permission].
System.Boolean	includeDeletedChildren	The value of this parameter affects HasChildren property.

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetPortalTabs(List<TabInfo>, Int32, Boolean, String, Boolean, Boolean, Boolean, Boolean, Boolean)

Gets the portal tabs.

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	The tabs.
System.Int32	excludeTabId	The exclude tab id.
System.Boolean	includeNoneSpecified	if set to true [include none specified].
System.String	noneSpecifiedText	The none specified text.
System.Boolean	includeHidden	if set to true [include hidden].
System.Boolean	includeDeleted	if set to true [include deleted].
System.Boolean	includeURL	if set to true [include URL].
System.Boolean	checkViewPermisison	if set to true [check view permission].
System.Boolean	checkEditPermission	if set to true [check edit permission].

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetPortalTabs(Int32, Int32, Boolean, Boolean, Boolean, Boolean)

Gets the portal tabs.

Declaration

public static List<TabInfo> GetPortalTabs(int portalId, int excludeTabId, bool includeNoneSpecified, bool includeHidden, bool includeDeleted, bool includeURL)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.
System.Int32	excludeTabId	The exclude tab id.
System.Boolean	includeNoneSpecified	if set to true [include none specified].
System.Boolean	includeHidden	if set to true [include hidden].
System.Boolean	includeDeleted	if set to true [include deleted].
System.Boolean	includeURL	if set to true [include URL].

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetPortalTabs(Int32, Int32, Boolean, Boolean)

Gets the portal tabs.

Declaration

public static List<TabInfo> GetPortalTabs(int portalId, int excludeTabId, bool includeNoneSpecified, bool includeHidden)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.
System.Int32	excludeTabId	The exclude tab id.
System.Boolean	includeNoneSpecified	if set to true [include none specified].
System.Boolean	includeHidden	if set to true [include hidden].

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetPortalTabs(Int32, Int32, Boolean, String, Boolean, Boolean, Boolean, Boolean, Boolean)

Gets the portal tabs.

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
System.Int32	portalId	The portal id.
System.Int32	excludeTabId	The exclude tab id.
System.Boolean	includeNoneSpecified	if set to true [include none specified].
System.String	noneSpecifiedText	The none specified text.
System.Boolean	includeHidden	if set to true [include hidden].
System.Boolean	includeDeleted	if set to true [include deleted].
System.Boolean	includeURL	if set to true [include URL].
System.Boolean	checkViewPermisison	if set to true [check view permission].
System.Boolean	checkEditPermission	if set to true [check edit permission].

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTab(Int32, Int32, Boolean)

Gets the tab.

Declaration

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

Parameters

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

Returns

Type	Description
TabInfo	tab info.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTab(Int32, Int32)

Gets the tab.

Declaration

public TabInfo GetTab(int tabId, int portalId)

Parameters

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

Returns

Type	Description
TabInfo	tab info.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTab(Int32)

TabController provides all operation to tabinfo.

Declaration

public TabInfo GetTab(int tabId)

Parameters

Type	Name	Description
System.Int32	tabId

Returns

Type	Description
TabInfo

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabByCulture(Int32, Int32, Locale)

Gets the tab by culture.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabByName(String, Int32, Int32)

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

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabByName(String, Int32)

Gets the name of the tab by name.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabByTabPath(Int32, String, String)

Gets the tab by tab path.

Declaration

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

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.
System.String	tabPath	The tab path.
System.String	cultureCode	The culture code.

Returns

Type	Description
System.Int32	The tab ID or -1.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabByUniqueID(Guid)

TabController provides all operation to tabinfo.

Declaration

public TabInfo GetTabByUniqueID(Guid uniqueID)

Parameters

Type	Name	Description
Guid	uniqueID

Returns

Type	Description
TabInfo

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabCount(Int32)

TabController provides all operation to tabinfo.

Declaration

public int GetTabCount(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
System.Int32

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabPathDictionary(Int32, String)

Gets the tab path dictionary.

Declaration

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

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.
System.String	cultureCode	The culture code.

Returns

Type	Description
Dictionary<System.String, System.Int32>	A mapping tab path to tab ID.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsByModuleID(Int32)

Gets the tabs which use the module.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsByPackageID(Int32, Int32, Boolean)

Gets the tabs which use the package.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsByParent(Int32, Int32)

Gets the tabs by parent.

Declaration

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

Parameters

Type	Name	Description
System.Int32	parentId	The parent id.
System.Int32	portalId	The portal id.

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsByParentId(Int32)

TabController provides all operation to tabinfo.

Declaration

public ArrayList GetTabsByParentId(int parentId)

Parameters

Type	Name	Description
System.Int32	parentId

Returns

Type	Description
ArrayList

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsByPortal(Int32)

Gets the tabs by portal.

Declaration

public TabCollection GetTabsByPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.

Returns

Type	Description
TabCollection	tab collection.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsBySortOrder(Int32, String, Boolean)

Gets the tabs by sort order.

Declaration

public static List<TabInfo> GetTabsBySortOrder(int portalId, string cultureCode, bool includeNeutral)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id.
System.String	cultureCode	The culture code.
System.Boolean	includeNeutral	if set to true [include neutral].

Returns

Type	Description
List<TabInfo>	A or TabInfo instances.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabsBySortOrder(Int32)

Get all TabInfo for the current culture in SortOrder.

Declaration

public static List<TabInfo> GetTabsBySortOrder(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID to load tabs for.

Returns

Type	Description
List<TabInfo>	List of TabInfo ordered by default SortOrder.

Remarks

This method uses the Active culture. There is an overload GetTabsBySortOrder(Int32, String, Boolean) which allows the culture information to be specified.

GetTabsByTabModuleID(Int32)

Gets the tabs which use the module.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabSettings(Int32)

read all settings for a tab from TabSettings table.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetTabUrls(Int32, Int32)

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

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GetUserTabsByPortal(Int32)

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

Declaration

public TabCollection GetUserTabsByPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
TabCollection	A new TabCollection instance.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

GiveTranslatorRoleEditRights(TabInfo, Dictionary<Int32, UserInfo>)

Gives the translator role edit rights.

Declaration

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

Parameters

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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

HasMissingLanguages(Int32, Int32)

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

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

IsDuplicateWithPortalAlias(Int32, String)

check whether have conflict between tab path and portal alias.

Declaration

public static bool IsDuplicateWithPortalAlias(int portalId, string tabPath)

Parameters

Type	Name	Description
System.Int32	portalId	portal id.
System.String	tabPath	tab path.

Returns

Type	Description
System.Boolean	true if the tab path is a duplicate of a portal alias, otherwise false.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

IsHostOrAdminPage(TabInfo)

Determines whether is host or admin tab.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

IsSpecialTab(Int32, PortalSettings)

Determines whether is special tab.

Declaration

public static bool IsSpecialTab(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 is special tab; otherwise, false.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

IsSpecialTab(Int32, Int32)

Determines whether is special tab.

Declaration

public static bool IsSpecialTab(int tabId, int portalId)

Parameters

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

Returns

Type	Description
System.Boolean	true if the page is special, otherwise false.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

IsTabPublished(TabInfo)

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

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

IsValidTabName(String, out String)

TabController provides all operation to tabinfo.

Declaration

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

Parameters

Type	Name	Description
System.String	tabName
System.String	invalidType

Returns

Type	Description
System.Boolean

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

LocalizeTab(TabInfo, Locale, Boolean)

Localizes the tab, with optional clear cache.

Declaration

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

Parameters

Type	Name	Description
TabInfo	originalTab
Locale	locale
System.Boolean	clearCache

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

LocalizeTab(TabInfo, Locale)

Localizes the tab.

Declaration

public void LocalizeTab(TabInfo originalTab, Locale locale)

Parameters

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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

MarkAsPublished(TabInfo)

It marks a page as published at least once.

Declaration

public void MarkAsPublished(TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The Tab to be marked.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

MoveTab(TabInfo, TabMoveType)

TabController provides all operation to tabinfo.

Declaration

public void MoveTab(TabInfo tab, TabMoveType type)

Parameters

Type	Name	Description
TabInfo	tab
TabMoveType	type

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

MoveTabAfter(TabInfo, Int32)

Moves the tab after a specific tab.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

MoveTabBefore(TabInfo, Int32)

Moves the tab before a specific tab.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

MoveTabToParent(TabInfo, Int32)

Moves the tab to a new parent.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

PopulateBreadCrumbs(ref TabInfo)

Populates the bread crumbs.

Declaration

public void PopulateBreadCrumbs(ref TabInfo tab)

Parameters

Type	Name	Description
TabInfo	tab	The tab.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

PopulateBreadCrumbs(Int32, ref ArrayList, Int32)

Populates the bread crumbs.

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

PublishTab(TabInfo)

Publishes the tab. Set the VIEW permission.

Declaration

public void PublishTab(TabInfo publishTab)

Parameters

Type	Name	Description
TabInfo	publishTab	The publish tab.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

PublishTabs(List<TabInfo>)

Publishes the tabs.

Declaration

public void PublishTabs(List<TabInfo> tabs)

Parameters

Type	Name	Description
List<TabInfo>	tabs	The tabs.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

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

public void RefreshCache(int portalId, int tabId)

Parameters

Type	Name	Description
System.Int32	portalId
System.Int32	tabId

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

RestoreTab(TabInfo, PortalSettings)

Restores the tab.

Declaration

public void RestoreTab(TabInfo tab, PortalSettings portalSettings)

Parameters

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

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

SaveTabUrl(TabUrlInfo, Int32, Boolean)

Save url information for a page (tab).

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

SerializeTab(XmlDocument, TabInfo, Boolean)

SerializeTab.

Declaration

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

Parameters

Type	Name	Description
XmlDocument	tabXml	The Xml Document to use for the Tab.
TabInfo	objTab	The TabInfo object to serialize.
System.Boolean	includeContent	A flag used to determine if the Module content is included.

Returns

Type	Description
XmlNode	An representing the page's data.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

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

SerializeTab.

Declaration

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

Parameters

Type	Name	Description
XmlDocument	tabXml	The Xml Document to use for the Tab.
Hashtable	tabs	A Hashtable used to store the names of the tabs.
TabInfo	tab	The TabInfo object to serialize.
PortalInfo	portal	The Portal object to which the tab belongs.
System.Boolean	includeContent	A flag used to determine if the Module content is included.

Returns

Type	Description
XmlNode	An representing the page's data.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

SoftDeleteTab(Int32, PortalSettings)

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

Declaration

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

UpdateTab(TabInfo)

Updates the tab to database.

Declaration

public void UpdateTab(TabInfo updatedTab)

Parameters

Type	Name	Description
TabInfo	updatedTab	The updated tab.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

UpdateTabSetting(Int32, String, String)

Adds or updates a tab's setting value.

Declaration

public 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

public 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.

Remarks

Tab is equal to page in DotNetNuke. Tabs will be a sitemap for a poatal, and every request at first need to check whether there is valid tab information include in the url, if not it will use default tab to display information.

Implements

ITabController

Extension Methods

JsonExtensionsWeb.ToJson(Object)