Back to Devexpress

ASPxNavBar Properties

aspnet-devexpress-dot-web-dot-aspxnavbar-dot-underscore-properties.md

latest40.8 KB
Original Source

ASPxNavBar Properties

Represents the web navigation bar control.

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
ActiveGroupGets or sets the active group within the navbar control.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
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.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoCollapseSpecifyies whether only one group can be expanded at a time.
AutoPostBackGets or sets a value that specifies whether server-side processing is required for specific predefined user actions.
BackColorGets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImageGets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BorderGets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottomGets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeftGets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRightGets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTopGets the settings of the web control’s top border. Inherited from ASPxWebControl.
BoundGets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameGets or sets the ASPxNavBar‘s client programmatic identifier.
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 the NavBar on the client.
CollapseImageGets an image a click on which collapses a group within the navbar.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ControlsGets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathGets or sets the path to a CSS file that defines the web control’s appearance. Inherited from ASPxWebControl.
CssPostfixGets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DataSourceSpecifies the object from which the data-bound control retrieves its data items. Inherited from ASPxDataWebControlBase.
DataSourceIDGets or sets the ID of the control from which the data-bound control retrieves its list of data items. Inherited from ASPxHierarchicalDataWebControl.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyleGets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
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 control’s content is updated via a callback.
EnableCallbackCompressionGets or sets whether callback result compression is enabled.
EnableCallBacksGets or sets a value that specifies whether the callback or postback technology is used to manage round trips to the server.
EnableClientSideAPIGets or sets a value that specifies whether the navbar control can be manipulated on the client side via code.
EnabledGets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableHotTrackGets or sets a value that specifies whether specific elements of NavBar (such as items or headers) can visually respond to mouse hovering.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from ASPxWebControl.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
ExpandButtonPositionGets or sets a value that specifies the position at which the expand button is displayed within all the groups of NavBar.
ExpandGroupActionGets or sets a value that specifies which action forces a group to be expanded/collapsed within a nav bar control.
ExpandImageGets an image a click on which expands a group within the navbar.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
GlobalAccessibilityCompliant staticGets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft staticGets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme staticGets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme staticGets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor staticGets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont staticGets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GroupContentStyleGets the style settings for the client regions of all groups within the navbar control.
GroupContentTemplateGets or sets a common template used for displaying the client region’s content of all groups within the navbar control.
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.
GroupHeaderImageGets the settings of a common group header image image which is displayed by all the group headers within the navbar control.
GroupHeaderImageCollapsedGets the settings of a common group header image image which is displayed by the headers of all the collapsed groups within the navbar control.
GroupHeaderStyleGets the style settings for all group headers within the navbar control.
GroupHeaderStyleCollapsedGets the style settings for the headers of all collapsed groups within the navbar control.
GroupHeaderTemplateGets or sets a common template used for displaying the content of all group headers within the navbar control.
GroupHeaderTemplateCollapsedGets or sets a common template used for displaying the content of the headers of all collapsed groups within the navbar control.
GroupsGets the collection of groups in NavBar.
GroupSpacingGets or sets the vertical spacing between the groups in the navigation bar control.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
ImageFolderGets or sets the path to the folder that contains images used by the control.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
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.
ItemImageGets the image settings, which is displayed by all the items within the ASPxNavBar control.
ItemLinkModeGets or sets a value that specifies how items are represented as links within the navbar control.
ItemsGets the collection of items within the navbar control.
ItemStyleGets the style settings for all items within the navbar control.
ItemTemplateGets or sets a common template used for displaying the content of all items within the navbar control.
ItemTextTemplateGets or sets a common template used for displaying the text content of all items within the navbar control.
JSPropertiesEnables you to supply any server data that can then be parsed on the client.
LinkStyleGets an object that contains style settings to be applied to links in the navbar control.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadingPanelDelayObsolete. Gets or sets the delay before displaying the loading panel in the navigation bar.
LoadingPanelImageGets the settings of an image to be displayed within a specific loading panel while waiting for a callback response.
LoadingPanelImagePositionObsolete. Gets or sets the position of an image displayed within a loading panel.
LoadingPanelStyleGets the style settings of a specific loading panel displayed as a group’s content while waiting for a callback response.
LoadingPanelTextObsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainerGets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control.
PaddingsGets the padding settings of the navbar control.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImagesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RenderModeObsolete. Gets or sets a value that specifies the render mode of the navigation bar elements.
RightToLeftSpecifies whether to apply right-to-left representation to the control.
SaveStateToCookiesGets or sets a value that specifies whether cookies are used to persist the expansion state of the NavBar’s groups.
SaveStateToCookiesIDGets or sets the name (identifier) of the cookie in which the NavBar’s state is persisted.
SelectedItemGets or sets the selected item within the navbar control.
SettingsLoadingPanelProvides access to the loading panel settings.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
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.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
SpriteCssFilePathGets or sets the path to a CSS file that defines the control’s sprite image settings.
SpriteImageUrlGets or sets the path to a sprite image.
StyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
SupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
SyncSelectionModeGets or sets whether the NavBar’s item, whose navigation location points to the currently browsed web page, is automatically selected.
SyncSelectionWithCurrentPathObsolete. Gets or sets whether the menu item, whose navigation location points to the currently browsed web page, is automatically selected.
IControlBuilderAccessor.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TabIndexGets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TargetGets or sets the window or frame at which to target the contents of the URLs associated with links within NavBar.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protectedGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control.
ViewStateIgnoresCase protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.

See Also

ASPxNavBar Class

ASPxNavBar Members

DevExpress.Web Namespace