Interface ITabVersionSettings

Class responsible to provide settings for Tab Versioning.

Namespace: DotNetNuke.Entities.Tabs.TabVersions
Assembly: DotNetNuke.dll
Syntax
public interface ITabVersionSettings

Methods

| Improve this Doc View Source

GetMaxNumberOfVersions(Int32)

Get the maximum number of version that the portal will kept for a tab.

Declaration
int GetMaxNumberOfVersions(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
Returns
Type Description
System.Int32

Max number of version.
| Improve this Doc View Source

GetTabVersionQueryStringParameter(Int32)

Get the query string parameter name to especify a Tab Version using the version number (i.e.: ?version=1).

Declaration
string GetTabVersionQueryStringParameter(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
Returns
Type Description
System.String

Query string parameter name.
| Improve this Doc View Source

IsVersioningEnabled(Int32, Int32)

Get the status of the tab versioning for an specific tab of the portal.

Declaration
bool IsVersioningEnabled(int portalId, int tabId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
System.Int32 tabId

Tab Id to be checked.
Returns
Type Description
System.Boolean

Returns true if tab versioning is enabled for the portal and for the tab, false otherwise.
Remarks

If versioning is disabled at portal level, the versioning for tabs will be disabled too.

| Improve this Doc View Source

IsVersioningEnabled(Int32)

Get the status of the tab versioning for the portal.

Declaration
bool IsVersioningEnabled(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
Returns
Type Description
System.Boolean

Returns true if tab versioning is enabled for the portal, false otherwise.
| Improve this Doc View Source

SetEnabledVersioningForPortal(Int32, Boolean)

Set the status of the tab versioning for the portal.

Declaration
void SetEnabledVersioningForPortal(int portalId, bool enabled)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
System.Boolean enabled

true for enable it, false otherwise.
| Improve this Doc View Source

SetEnabledVersioningForTab(Int32, Boolean)

Set the status of the tab versioning for a tab.

Declaration
void SetEnabledVersioningForTab(int tabId, bool enabled)
Parameters
Type Name Description
System.Int32 tabId

Tab Id.
System.Boolean enabled

true for enable it, false otherwise.
| Improve this Doc View Source

SetMaxNumberOfVersions(Int32, Int32)

Set the maximum number of version that the portal will kept for a tab.

Declaration
void SetMaxNumberOfVersions(int portalId, int maxNumberOfVersions)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
System.Int32 maxNumberOfVersions

Max number of version.

Extension Methods