Class TabWorkflowSettings
Inheritance
Implements
Inherited Members
Namespace: DotNetNuke.Entities.Tabs
Assembly: DotNetNuke.dll
Syntax
public class TabWorkflowSettings : ServiceLocator<ITabWorkflowSettings, TabWorkflowSettings>, ITabWorkflowSettings
Constructors
| Improve this Doc View SourceTabWorkflowSettings()
Initializes a new instance of the TabWorkflowSettings class.
Declaration
public TabWorkflowSettings()
Methods
| Improve this Doc View SourceGetDefaultTabWorkflowId(Int32)
This method returns the default tab workflow of the portal.
Declaration
public int GetDefaultTabWorkflowId(int portalId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | Portal Id. |
Returns
Type | Description |
---|---|
System.Int32 | The workflow Id of the portal default workflow. |
Remarks
If no default workflow is defined for a portal the method returns the Direct Publish system workflow.
GetFactory()
Gets the service locator factory.
Declaration
protected override Func<ITabWorkflowSettings> GetFactory()
Returns
Type | Description |
---|---|
Func<ITabWorkflowSettings> | A factory function. |
Overrides
IsWorkflowEnabled(Int32, Int32)
The method returns true if the workflow is enabled for a tab.
Declaration
public bool IsWorkflowEnabled(int portalId, int tabId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | Portal Id. |
System.Int32 | tabId | Tab Id. |
Returns
Type | Description |
---|---|
System.Boolean | True if the workflow is enabled, false otherwise. |
IsWorkflowEnabled(Int32)
The method returns true is the workflow is enabled at portal level.
Declaration
public bool IsWorkflowEnabled(int portalId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | Portal Id. |
Returns
Type | Description |
---|---|
System.Boolean | True if the workflow is enabled, false otherwise. |
SetDefaultTabWorkflowId(Int32, Int32)
This method sets the default workflow for a portal.
Declaration
public void SetDefaultTabWorkflowId(int portalId, int workflowId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | Portal Id. |
System.Int32 | workflowId | Workflow Id. |
SetWorkflowEnabled(Int32, Boolean)
This method enables or disables the tab workflow for the entire portal.
Declaration
public void SetWorkflowEnabled(int portalId, bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | Portal Id. |
System.Boolean | enabled | true for enable it, false for disable it. |
SetWorkflowEnabled(Int32, Int32, Boolean)
This method enables or disables the tab workflow for a specific tab.
Declaration
public void SetWorkflowEnabled(int portalId, int tabId, bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | Portal Id. |
System.Int32 | tabId | Tab Id. |
System.Boolean | enabled | true for enable it, false for disable it. |
Remarks
this won't enable workflow of a tab if the tab workflow is disabled at portal level.