Class NavigationProvider

Inheritance
object
Control
TemplateControl
UserControl
UserControlBase
NavigationProvider
Implements
Inherited Members
Namespace: DotNetNuke.Modules.NavigationProvider
Assembly: DotNetNuke.dll
Syntax
public abstract class NavigationProvider : UserControlBase, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IFilterResolutionService, IAttributeAccessor, INamingContainer, IUserControlDesignerAccessor

Constructors

NavigationProvider()

Declaration
protected NavigationProvider()

Properties

CSSBreadCrumbRoot

Declaration
public virtual string CSSBreadCrumbRoot { get; set; }
Property Value
Type Description
string

CSSBreadCrumbSub

Declaration
public virtual string CSSBreadCrumbSub { get; set; }
Property Value
Type Description
string

CSSBreak

Declaration
public virtual string CSSBreak { get; set; }
Property Value
Type Description
string

CSSContainerRoot

Declaration
public virtual string CSSContainerRoot { get; set; }
Property Value
Type Description
string

CSSContainerSub

Declaration
public virtual string CSSContainerSub { get; set; }
Property Value
Type Description
string

CSSControl

Declaration
public abstract string CSSControl { get; set; }
Property Value
Type Description
string

CSSIcon

Declaration
public virtual string CSSIcon { get; set; }
Property Value
Type Description
string

CSSIndicateChildRoot

Declaration
public virtual string CSSIndicateChildRoot { get; set; }
Property Value
Type Description
string

CSSIndicateChildSub

Declaration
public virtual string CSSIndicateChildSub { get; set; }
Property Value
Type Description
string

CSSLeftSeparator

Declaration
public virtual string CSSLeftSeparator { get; set; }
Property Value
Type Description
string

CSSLeftSeparatorBreadCrumb

Declaration
public virtual string CSSLeftSeparatorBreadCrumb { get; set; }
Property Value
Type Description
string

CSSLeftSeparatorSelection

Declaration
public virtual string CSSLeftSeparatorSelection { get; set; }
Property Value
Type Description
string

CSSNode

Declaration
public virtual string CSSNode { get; set; }
Property Value
Type Description
string

CSSNodeHover

Declaration
public virtual string CSSNodeHover { get; set; }
Property Value
Type Description
string

CSSNodeHoverRoot

Declaration
public virtual string CSSNodeHoverRoot { get; set; }
Property Value
Type Description
string

CSSNodeHoverSub

Declaration
public virtual string CSSNodeHoverSub { get; set; }
Property Value
Type Description
string

CSSNodeRoot

Declaration
public virtual string CSSNodeRoot { get; set; }
Property Value
Type Description
string

CSSNodeSelectedRoot

Declaration
public virtual string CSSNodeSelectedRoot { get; set; }
Property Value
Type Description
string

CSSNodeSelectedSub

Declaration
public virtual string CSSNodeSelectedSub { get; set; }
Property Value
Type Description
string

CSSRightSeparator

Declaration
public virtual string CSSRightSeparator { get; set; }
Property Value
Type Description
string

CSSRightSeparatorBreadCrumb

Declaration
public virtual string CSSRightSeparatorBreadCrumb { get; set; }
Property Value
Type Description
string

CSSRightSeparatorSelection

Declaration
public virtual string CSSRightSeparatorSelection { get; set; }
Property Value
Type Description
string

CSSSeparator

Declaration
public virtual string CSSSeparator { get; set; }
Property Value
Type Description
string

ControlAlignment

Declaration
public virtual NavigationProvider.Alignment ControlAlignment { get; set; }
Property Value
Type Description
NavigationProvider.Alignment

ControlID

Declaration
public abstract string ControlID { get; set; }
Property Value
Type Description
string

ControlOrientation

Declaration
public virtual NavigationProvider.Orientation ControlOrientation { get; set; }
Property Value
Type Description
NavigationProvider.Orientation

CustomAttributes

Declaration
public virtual List<CustomAttribute> CustomAttributes { get; set; }
Property Value
Type Description
List<CustomAttribute>

EffectsDuration

Declaration
public virtual double EffectsDuration { get; set; }
Property Value
Type Description
double

EffectsShadowColor

Declaration
public virtual string EffectsShadowColor { get; set; }
Property Value
Type Description
string

EffectsShadowDirection

Declaration
public virtual string EffectsShadowDirection { get; set; }
Property Value
Type Description
string

EffectsShadowStrength

Declaration
public virtual int EffectsShadowStrength { get; set; }
Property Value
Type Description
int

EffectsStyle

Declaration
public virtual string EffectsStyle { get; set; }
Property Value
Type Description
string

EffectsTransition

Declaration
public virtual string EffectsTransition { get; set; }
Property Value
Type Description
string

ForceCrawlerDisplay

Declaration
public virtual string ForceCrawlerDisplay { get; set; }
Property Value
Type Description
string

ForceDownLevel

Declaration
public virtual string ForceDownLevel { get; set; }
Property Value
Type Description
string

IndicateChildImageExpandedRoot

Declaration
public virtual string IndicateChildImageExpandedRoot { get; set; }
Property Value
Type Description
string

IndicateChildImageExpandedSub

Declaration
public virtual string IndicateChildImageExpandedSub { get; set; }
Property Value
Type Description
string

IndicateChildImageRoot

Declaration
public virtual string IndicateChildImageRoot { get; set; }
Property Value
Type Description
string

IndicateChildImageSub

Declaration
public virtual string IndicateChildImageSub { get; set; }
Property Value
Type Description
string

IndicateChildren

Declaration
public virtual bool IndicateChildren { get; set; }
Property Value
Type Description
bool

MouseOutHideDelay

Declaration
public virtual decimal MouseOutHideDelay { get; set; }
Property Value
Type Description
decimal

MouseOverAction

Declaration
public virtual NavigationProvider.HoverAction MouseOverAction { get; set; }
Property Value
Type Description
NavigationProvider.HoverAction

MouseOverDisplay

Declaration
public virtual NavigationProvider.HoverDisplay MouseOverDisplay { get; set; }
Property Value
Type Description
NavigationProvider.HoverDisplay

NavigationControl

Declaration
public abstract Control NavigationControl { get; }
Property Value
Type Description
Control

NodeLeftHTMLBreadCrumbRoot

Declaration
public virtual string NodeLeftHTMLBreadCrumbRoot { get; set; }
Property Value
Type Description
string

NodeLeftHTMLBreadCrumbSub

Declaration
public virtual string NodeLeftHTMLBreadCrumbSub { get; set; }
Property Value
Type Description
string

NodeLeftHTMLRoot

Declaration
public virtual string NodeLeftHTMLRoot { get; set; }
Property Value
Type Description
string

NodeLeftHTMLSub

Declaration
public virtual string NodeLeftHTMLSub { get; set; }
Property Value
Type Description
string

NodeRightHTMLBreadCrumbRoot

Declaration
public virtual string NodeRightHTMLBreadCrumbRoot { get; set; }
Property Value
Type Description
string

NodeRightHTMLBreadCrumbSub

Declaration
public virtual string NodeRightHTMLBreadCrumbSub { get; set; }
Property Value
Type Description
string

NodeRightHTMLRoot

Declaration
public virtual string NodeRightHTMLRoot { get; set; }
Property Value
Type Description
string

NodeRightHTMLSub

Declaration
public virtual string NodeRightHTMLSub { get; set; }
Property Value
Type Description
string

PathImage

Declaration
public virtual string PathImage { get; set; }
Property Value
Type Description
string

PathSystemImage

Declaration
public virtual string PathSystemImage { get; set; }
Property Value
Type Description
string

PathSystemScript

Declaration
public virtual string PathSystemScript { get; set; }
Property Value
Type Description
string

PopulateNodesFromClient

Declaration
public virtual bool PopulateNodesFromClient { get; set; }
Property Value
Type Description
bool

SeparatorHTML

Declaration
public virtual string SeparatorHTML { get; set; }
Property Value
Type Description
string

SeparatorLeftHTML

Declaration
public virtual string SeparatorLeftHTML { get; set; }
Property Value
Type Description
string

SeparatorLeftHTMLActive

Declaration
public virtual string SeparatorLeftHTMLActive { get; set; }
Property Value
Type Description
string

SeparatorLeftHTMLBreadCrumb

Declaration
public virtual string SeparatorLeftHTMLBreadCrumb { get; set; }
Property Value
Type Description
string

SeparatorRightHTML

Declaration
public virtual string SeparatorRightHTML { get; set; }
Property Value
Type Description
string

SeparatorRightHTMLActive

Declaration
public virtual string SeparatorRightHTMLActive { get; set; }
Property Value
Type Description
string

SeparatorRightHTMLBreadCrumb

Declaration
public virtual string SeparatorRightHTMLBreadCrumb { get; set; }
Property Value
Type Description
string

StyleBackColor

Declaration
public virtual string StyleBackColor { get; set; }
Property Value
Type Description
string

StyleBorderWidth

Declaration
public virtual decimal StyleBorderWidth { get; set; }
Property Value
Type Description
decimal

StyleControlHeight

Declaration
public virtual decimal StyleControlHeight { get; set; }
Property Value
Type Description
decimal

StyleFontBold

Declaration
public virtual string StyleFontBold { get; set; }
Property Value
Type Description
string

StyleFontNames

Declaration
public virtual string StyleFontNames { get; set; }
Property Value
Type Description
string

StyleFontSize

Declaration
public virtual decimal StyleFontSize { get; set; }
Property Value
Type Description
decimal

StyleForeColor

Declaration
public virtual string StyleForeColor { get; set; }
Property Value
Type Description
string

StyleHighlightColor

Declaration
public virtual string StyleHighlightColor { get; set; }
Property Value
Type Description
string

StyleIconBackColor

Declaration
public virtual string StyleIconBackColor { get; set; }
Property Value
Type Description
string

StyleIconWidth

Declaration
public virtual decimal StyleIconWidth { get; set; }
Property Value
Type Description
decimal

StyleNodeHeight

Declaration
public virtual decimal StyleNodeHeight { get; set; }
Property Value
Type Description
decimal

StyleRoot

Declaration
public virtual string StyleRoot { get; set; }
Property Value
Type Description
string

StyleSelectionBorderColor

Declaration
public virtual string StyleSelectionBorderColor { get; set; }
Property Value
Type Description
string

StyleSelectionColor

Declaration
public virtual string StyleSelectionColor { get; set; }
Property Value
Type Description
string

StyleSelectionForeColor

Declaration
public virtual string StyleSelectionForeColor { get; set; }
Property Value
Type Description
string

StyleSub

Declaration
public virtual string StyleSub { get; set; }
Property Value
Type Description
string

SupportsPopulateOnDemand

Declaration
public abstract bool SupportsPopulateOnDemand { get; }
Property Value
Type Description
bool

WorkImage

Declaration
public virtual string WorkImage { get; set; }
Property Value
Type Description
string

Methods

Bind(DNNNodeCollection)

Declaration
public abstract void Bind(DNNNodeCollection objNodes)
Parameters
Type Name Description
DNNNodeCollection objNodes

ClearNodes()

Declaration
public virtual void ClearNodes()

Initialize()

Declaration
public abstract void Initialize()

Instance(IServiceProvider, string)

Declaration
public static NavigationProvider Instance(IServiceProvider serviceProvider, string friendlyName)
Parameters
Type Name Description
IServiceProvider serviceProvider
string friendlyName
Returns
Type Description
NavigationProvider

Instance(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IServiceProvider. Scheduled for removal in v12.0.0.")]
public static NavigationProvider Instance(string friendlyName)
Parameters
Type Name Description
string friendlyName
Returns
Type Description
NavigationProvider

RaiseEvent_NodeClick(DNNNode)

Declaration
protected void RaiseEvent_NodeClick(DNNNode objNode)
Parameters
Type Name Description
DNNNode objNode

RaiseEvent_NodeClick(string)

Declaration
protected void RaiseEvent_NodeClick(string strID)
Parameters
Type Name Description
string strID

RaiseEvent_PopulateOnDemand(DNNNode)

Declaration
protected void RaiseEvent_PopulateOnDemand(DNNNode objNode)
Parameters
Type Name Description
DNNNode objNode

RaiseEvent_PopulateOnDemand(string)

Declaration
protected void RaiseEvent_PopulateOnDemand(string strID)
Parameters
Type Name Description
string strID

Events

NodeClick

Declaration
public event NavigationProvider.NodeClickEventHandler NodeClick
Event Type
Type Description
NavigationProvider.NodeClickEventHandler

PopulateOnDemand

Declaration
public event NavigationProvider.PopulateOnDemandEventHandler PopulateOnDemand
Event Type
Type Description
NavigationProvider.PopulateOnDemandEventHandler

Implements

Extension Methods