NavBarGroup Members

A group within a NavBarControl control.

Constructors

Name Description
NavBarGroup() Creates an instance of the NavBarGroup class.
NavBarGroup(String) Initializes a new instance of the NavBarGroup class, with the specified caption.

Fields

Name Description
DefaultImageSize static Stores the original size of an image assigned to the NavElement.LargeImage or NavElement.SmallImage property. Inherited from NavElement.

Properties

Name Description
AllowGlyphSkinning Gets or sets whether the current NavElement's icon should be painted in this item's foreground color. Inherited from NavElement.
AllowHtmlString Gets or sets whether the element's caption is formatted using HTML tags. Inherited from NavElement.
Appearance Gets the appearance settings used to paint the element. Inherited from NavElement.
AppearanceBackground Gets the appearance settings used to paint the group's background.
AppearanceHotTracked Gets the appearance settings used to paint the current element when it's hot-tracked. Inherited from NavElement.
AppearancePressed Gets the appearance settings used to paint the element when it's pressed. Inherited from NavElement.
BackgroundImage Gets or sets the group's background image.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Caption Gets or sets the element's caption. Inherited from NavElement.
CollapsedNavPaneContentControl Gets or sets the control embedded into the NavBarControl when the nav bar is painted using the Navigation Pane View, the current group is active and the nav bar is collapsed.
Collection Gets a collection of groups to which the group belongs.
Container Gets the IContainer that contains the Component. Inherited from Component.
ControlContainer Gets or sets the control container displayed by the group when its NavBarGroup.GroupStyle property is set to NavBarGroupStyle.ControlContainer.
ControlContainerName Gets or sets the control container's name for the current group.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DragDropFlags Gets or sets a set of flags controlling the group's behavior as it relates to link drag and drop operations.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Expanded Gets or sets a value specifying whether the group is expanded.
GroupCaptionUseImage Gets or sets whether a big or small image is displayed within the group caption.
GroupClientHeight Gets or sets the height of the group's client area.
GroupStyle Gets or sets the way links are displayed within the current group, or whether to display a custom control within the group.
Hint Gets or sets the element's hint text. Inherited from NavElement.
ImageOptions Provides access to settings that allow you to set up raster and vector icons for this NavElement. Inherited from NavElement.
ImageUri Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current NavElement. A specific version of the addressed image is automatically chosen, based on the app context (the current skin and required image size). Inherited from NavElement.
ItemLinks Gets an object containing the collection of links which belong to the group.
LargeImage Specifies the large image displayed within the element. Inherited from NavElement.
LargeImageIndex Specifies the element's large image by its index within the source image collection. Inherited from NavElement.
LargeImages Gets the source of the large images that can be displayed in the group headers and links. Inherited from NavElement.
LargeImageSize Gets or sets the size of the current NavElement's large image. Inherited from NavElement.
LinksUseSmallImage Obsolete. Gets or sets a value specifying whether group links use small or large images.
Name Gets or sets the item's name. Inherited from ComponentCollectionItem.
NavBar Gets the control to which the element belongs. Inherited from NavElement.
NavigationPaneVisible Gets or sets whether the group's button is displayed at the bottom of the NavBarControl when the "NavigationPane" view is applied.
SelectedLink Gets or sets an object representing the group's selected link.
SelectedLinkIndex Gets or sets a value specifying the index of the group's selected link.
ShowAsIconsView Obsolete. Gets or sets a value specifying whether links are displayed as a set of icons.
ShowIcons Gets or sets whether link icons are shown in the current group.
Site Gets or sets the ISite of the Component. Inherited from Component.
SmallImage Specifies the small image displayed within the element. Inherited from NavElement.
SmallImageIndex Specifies the element's small image by its index within the source image collection. Inherited from NavElement.
SmallImages Gets the source of the small images that can be displayed in the group headers and links. Inherited from NavElement.
SmallImageSize Gets or sets the size for the current NavElement's small image. Inherited from NavElement.
State Returns the NavBar group's state.
SuperTip Gets or sets a super tool-tip for the current NavElement. Inherited from NavElement.
Tag Gets or sets data associated with the element. Inherited from NavElement.
TextureBackgroundBrush Gets an object representing the brush used to fill the group client area.
TopVisibleLinkIndex Gets or sets the index of the link which is displayed at the top of the current group.
UseSmallImage Obsolete. Gets or sets a value specifying whether a large or small image is displayed within the group caption.
Visible Gets or sets a value specifying the visibility of the element. Inherited from NavElement.
VisibleItemLinks Gets the collection of currently visible links within the group.

Methods

Name Description
AddItem() Creates a new item in a NavBarControl and creates a link to this item in the current group.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetDragDropFlags() Returns a set of flags which unambiguously specify the group's drag-and-drop behavior.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetImage() Returns the image to display within the group caption.
GetImageSize() Returns the width and height of the image displayed within the group caption.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetLinksUseSmallImage() Gets whether the links belonging to the group use small images.
GetPreferredImageSize() This member supports the internal infrastructure, and is not intended to be used directly from your code.
GetPreferredImageSize(Size) This member supports the internal infrastructure, and is not intended to be used directly from your code.
GetPreferredImageSize(Size, Boolean) This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from NavElement.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetShowAsIconsView() Gets whether the group's links are displayed using only images and without captions.
GetType() Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InsertItem(Int32) Creates a new item in a NavBarControl and creates a link to this item at the specified position in the current group.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ResetSuperTip() Removes the current NavElement's super tool-tip. Inherited from NavElement.
ToString() Returns the element's full name. Inherited from NavElement.

Events

Name Description
CalcGroupClientHeight Fires when the group's client height is calculated.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ItemChanged Fires when item property values are changed. Inherited from ComponentCollectionItem.
See Also