NavigationBar

Inheritance Hierarchy

          IComponent

          IControl

          INavigationBar

          NavigationBar

Description

The NavigationBar component is used to create a navigation bar.

Working with the Component

The navigation bar is created from vertically arranged tabs. Each tab consists of a title and a controls panel. The tab activates on clicking its title. If required, each tab can be hidden.

Use software to create a collection of tabs for customizing the component. To create a tab, create an instance of the class  NavigationBarPad  and include it in the collection  Pads  of the NavigationBar component. For each tab set up a title (the  INavigationBarPad.Header property) and a panel (the  INavigationBarPad.Content). A title can include text and a control. The panel associated with the title is a frame for the form with controls. The form identifier is specified in the INavigationBarPanel.MetabaseObject property.

Example

Properties of the NavigationBar Component

  Property name Brief description
ActivePad The ActivePad property determines the active component tab.
Align The Align property determines the behavior of the component, when the size of its parent component is changed.
AllowDrag The AllowDrag property determines whether an object can be dragged from the component.
AllowDrop The AllowDrop property determines whether the component can accept a dragged object.
Anchors The Anchors property returns settings that determine the percentage of the size change for the current component when the parent component is resized.
Border The Border property determines the borders to be drawn for the component.
Brush The Brush property specifies the brush used to fill the component area.
ClientHeight The ClientHeight property is used to receive or specify the height of the component’s client space.
ClientWidth The ClientWidth property is used to receive or specify the width of the component’s client space.
Color The Color property determines the background color of a component.
ComponentCount The ComponentCount property returns the number of child components.
Components The Components property returns the child component.
Cursor The Cursor property determines the look of the cursor over the component.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether the component is available for the user.
Focused The Focused property returns True, if the focus is set on the component.
Font The Font property determines the set of characteristics, describing the font, used to display text.
Height The Height property determines the component height.
HelpContext The HelpContext property determines a unique index for the context help section for this component.
Hint The Hint property determines the hint text for the component.
Left The Left property determines the coordinate of the left border of the component.
Name The Name property determines the component name.
Pads The Pads property returns the collection of tabs of the navigation bar.
Parent The Parent property determines the parent component.
ParentColor The ParentColor property determines whether the component inherits the color of the parent component.
ParentFont The ParentFont property determines whether the component should use the font of the parent component.
ParentShowHint The ParentShowHint property determines when a tooltip is displayed.
PopupMenu The PopupMenu property determines the context menu to be displayed on right-click.
ShowHint The ShowHint property enables and disables showing a hint for the component.
TabOrder The TabOrder property determines the component position in the tab order.
TabStop The TabStop property determines whether the focus is set to a component when the Tab button is pressed.
Tag The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as required.
Text The Text property determines the row identifying a component for user.
Top The Top property determines the coordinate of the top border of the component.
Visible The Visible property determines the visibility of the component during execution.
Width The Width property determines the component width.

Methods of the NavigationBar Component

  Method name Brief description
BeginUpdate The BeginUpdate method prohibits component redrawing.
BringToFront The BringToFront method brings a component to front.
ClientToScreen The ClientToScreen method converts point coordinates relative to component coordinates into display coordinates.
DoDragDrop The DoDragDrop method allows to start drag-and-drop operation.
EndUpdate The EndUpdate method renews component redrawing.
GetImage The GetImage method returns the image of the component with all the child components.
ScreenToClient The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
SendToBack The SendToBack method sends a component to back.
SetFocus The SetFocus method sets focus to this component.

Events of the NavigationBar Component

  Event name Brief description
OnActivePadChanged The OnActivePadChanged event is fired on after changing the active tab of the navigation bar.
OnActivePadChanging The OnActivePadChanging event is fired on before changing the active tan of the navigation bar.
OnPadValueChanged The OnPadValueChanged event is fired on changing selection of the checkbox displayed in the tab title.

See also:

Additional Components