Back to Devexpress

NavBarSettings Members

aspnetmvc-devexpress-dot-web-dot-mvc-dot-navbarsettings-dot-underscore-members.md

latest16.0 KB
Original Source

NavBarSettings Members

Contains the NavBar extension settings.

Constructors

NameDescription
NavBarSettings()Initializes a new instance of the NavBarSettings class with default settings.

Properties

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
AllowExpandingSpecifies whether the expansion state of the navbar groups can be changed.
AllowSelectItemGets or sets a value specifying whether items can be selected within NavBar.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
AutoCollapseGets or sets a value specifying whether only one group can be expanded at a time within the NavBar.
BeforeGetCallbackResultAllows you to perform custom actions after a callback sent by the current extension has been processed on the server, but prior to the time the respective callback result render is formed.
CallbackRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks.
ClientLayoutEnables you to save and restore the previously saved layout of the NavBar.
ClientSideEventsGets an object that lists the client-side events specific to the NavBar.
ClientVisibleGets or sets a value that specifies the initial visibility state of a NavBar on the client.
ControlStyleProvides access to the style settings declared at the root level of the NavBar’s wrapped web server control.
CustomJSPropertiesEnables you to supply any server data that can then be parsed on the client.
DataBindingAllows you to perform custom actions before a NavBar is bound to a data source.
DataBoundAllows you to perform specific actions after the NavBar is bound to a data source.
EnableAnimationGets or sets a value that specifies whether a specific animation effect is used when expanding/collapsing groups.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a navigation bar’s content is updated via a callback.
EnableClientSideAPIGets or sets a value that specifies whether the extension to which this NavBarSettings object is passed can be manipulated on the client side via code.
EnabledGets or sets a value that indicates whether the MVC Extension is enabled, allowing it to respond to end-user interactions. Inherited from SettingsBase.
EnableHotTrackGets or sets a value that specifies whether specific elements of a NavBar (such as items or headers) can visually respond to mouse hovering.
EnableThemingGets or sets a value indicating whether themes apply to this extension. Inherited from SettingsBase.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from SettingsBase.
ExpandButtonPositionGets or sets a value that specifies the position at which the expand button is displayed within all the groups of NavBar.
GroupDataBoundEnables you to customize settings of the related group before it is finally rendered.
GroupDataFieldsProvides access to properties allowing you to specify data fields (attributes of xml elements) from which group settings of a bound NavBar should be obtained.
GroupsGets the collection of groups in NavBar.
HeightGets or sets the height of the extension. Inherited from SettingsBase.
ImagesProvides access to the settings that define images for various elements within the NavBar.
InitEnables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
ItemDataBoundEnables you to customize settings of the related item before it is finally rendered.
ItemDataFieldsProvides access to properties allowing you to specify data fields (attributes of xml elements) from which item settings of a bound NavBar should be obtained.
ItemLinkModeGets or sets a value that specifies how items are represented as links within the NavBar.
LoadingPanelImagePositionObsolete. Gets or sets the position of an image displayed within a loading panel.
LoadingPanelTextObsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response.
NameSpecifies the unique identifier name for the extension. Inherited from SettingsBase.
PreRenderAllows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
RightToLeftSpecifies whether to apply right-to-left representation to the extension.
SaveStateToCookiesGets or sets a value that specifies whether cookies are used to persist information about the NavBar’s state.
SaveStateToCookiesIDGets or sets the name (identifier) of the cookie in which the NavBar’s state is persisted.
SettingsLoadingPanelProvides access to the loading panel’s settings.
ShowExpandButtonsGets or sets a value that specifies whether group expand buttons are displayed within the NavBar’s group headers.
ShowGroupHeadersGets or sets a value that specifies whether group headers are displayed within NavBar.
ShowLoadingPanelObsolete. Gets or sets whether the loading panel can be displayed.
ShowLoadingPanelImageObsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response.
SkinIDGets or sets the skin to apply to the control. Inherited from SettingsBase.
StyleGets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
StylesProvides access to the style settings that control the appearance of the extension’s visual elements.
SyncSelectionModeGets or sets whether the NavBar’s item, whose navigation location points to the currently browsed web page, is automatically selected.
TabIndexGets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
TargetGets or sets the window or frame at which to target the contents of the URLs associated with links within NavBar.
ThemeGets or sets the name of the theme to be applied to the extension. Inherited from SettingsBase.
ToolTipGets or sets a UI element’s tooltip text. Inherited from SettingsBase.
WidthGets or sets the width of the extension. Inherited from SettingsBase.

Methods

NameDescription
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
SetGroupContentTemplateContent(Action<NavBarGroupTemplateContainer>)Allows you to specify a common template for the client region’s content of all NavBar groups.
SetGroupContentTemplateContent(String)Allows you to specify a common template for the client region’s content of all NavBar groups.
SetGroupHeaderTemplateCollapsedContent(Action<NavBarGroupTemplateContainer>)Allows you to specify a common template for the content of the headers of all NavBar collapsed groups.
SetGroupHeaderTemplateCollapsedContent(String)Allows you to specify a common template for the content of the headers of all NavBar collapsed groups.
SetGroupHeaderTemplateContent(Action<NavBarGroupTemplateContainer>)Allows you to specify a common template for all NavBar group headers.
SetGroupHeaderTemplateContent(String)Allows you to specify a common template for all NavBar group headers.
SetItemTemplateContent(Action<NavBarItemTemplateContainer>)Allows you to specify a common template for all NavBar items.
SetItemTemplateContent(String)Allows you to specify a common template for the content of all NavBar items.
SetItemTextTemplateContent(Action<NavBarItemTemplateContainer>)Allows you to specify a common template for the text content of all NavBar items.
SetItemTextTemplateContent(String)Allows you to specify a common template for the text content of all NavBar items.
ToString()Returns a string that represents the current object. Inherited from Object.

See Also

NavBarSettings Class

DevExpress.Web.Mvc Namespace