Class PersonaBarContainer
Implements
Inherited Members
Namespace: Dnn.PersonaBar.Library.Containers
Assembly: Dnn.PersonaBar.Library.dll
Syntax
public class PersonaBarContainer : IPersonaBarContainer
Constructors
PersonaBarContainer()
Initializes a new instance of the PersonaBarContainer class.
Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with INavigationManager. Scheduled removal in v12.0.0.")]
public PersonaBarContainer()
PersonaBarContainer(INavigationManager, IPersonaBarController)
Initializes a new instance of the PersonaBarContainer class.
Declaration
public PersonaBarContainer(INavigationManager navigationManager, IPersonaBarController personaBarController)
Parameters
| Type | Name | Description |
|---|---|---|
| INavigationManager | navigationManager | The navigation manager. |
| IPersonaBarController | personaBarController | The Persona Bar controller. |
PersonaBarContainer(INavigationManager, IPersonaBarController, IHostSettings)
Initializes a new instance of the PersonaBarContainer class.
Declaration
public PersonaBarContainer(INavigationManager navigationManager, IPersonaBarController personaBarController, IHostSettings hostSettings)
Parameters
| Type | Name | Description |
|---|---|---|
| INavigationManager | navigationManager | The navigation manager. |
| IPersonaBarController | personaBarController | The Persona Bar controller. |
| IHostSettings | hostSettings | The host settings. |
Properties
Instance
Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.0. Please resolve via dependency injection. Scheduled removal in v12.0.0.")]
public static IPersonaBarContainer Instance { get; }
Property Value
| Type | Description |
|---|---|
| IPersonaBarContainer |
NavigationManager
Declaration
protected INavigationManager NavigationManager { get; }
Property Value
| Type | Description |
|---|---|
| INavigationManager |
RootItems
Gets items allowed to defined in root level.
Declaration
public virtual IList<string> RootItems { get; }
Property Value
| Type | Description |
|---|---|
| IList<string> |
Visible
Gets a value indicating whether persona bar is available.
Declaration
public virtual bool Visible { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Methods
ClearInstance()
Declaration
public static void ClearInstance()
FilterMenu(PersonaBarMenu)
Declaration
public virtual void FilterMenu(PersonaBarMenu menu)
Parameters
| Type | Name | Description |
|---|---|---|
| PersonaBarMenu | menu |
GetConfiguration()
Get Persona Bar Settings.
Declaration
public virtual IDictionary<string, object> GetConfiguration()
Returns
| Type | Description |
|---|---|
| IDictionary<string, object> | An IDictionary<TKey, TValue> instance. |
Initialize(UserControl)
Initialize the persona bar container.
Declaration
public virtual void Initialize(UserControl personaBarControl)
Parameters
| Type | Name | Description |
|---|---|---|
| UserControl | personaBarControl | The Persona Bar Container control. |
SetInstance(IPersonaBarContainer, bool)
Declaration
public static void SetInstance(IPersonaBarContainer instance, bool overwrite = false)
Parameters
| Type | Name | Description |
|---|---|---|
| IPersonaBarContainer | instance | |
| bool | overwrite |