TNotebook class

In unit ExtCtrls

TNotebook is a container for a group of related pages.

Declaration

pascal

TNotebook = class(TCustomControl)

Inheritance

Description

TNotebook is a control which can hold a series of pages order by their position in the list of pages. Only one page is shown at a time.

This control is entirely custom drawn, which means that it is available - and looks the same - in any widgetset which supports TCustomControl. The pages are containers which can hold other controls. The page control does not display a tab which indicates the active page. If you are looking for a control with tabs representing each of the pages, please see TPageControl instead.

To use a Notebook, select its icon from the 'Additional' tab of the Component Palette and place it on the Form. Adjust its size, position, alignment and anchoring as required, by moving the object on the Form or by using the Object Inspector.

Pages are added to the NoteBook by selecting the control and right-clicking with the mouse to get a pop-up menu whose first item is 'Add Page', or by using the Pages property editor in the Object Inspector. Pages already in the NoteBook can be edited by selecting the appropriate ActivePage in the Object Inspector and modifying its properties or adding additional components to the Page.

Properties

`ActivePage`	public	Gets the name for the active page object in the notebook control.
`ActivePageComponent`	public	Contains the TPage instance representing the active page in the notebook control.
`Page`	public	Provides access to a page object in the notebook control by its ordinal position in the list of pages.
`PageCount`	public	Indicates the number of page objects defined for the notebook control.
`PageIndex`	published	Ordinal position for the active page in the notebook control.
`Pages`	published	Contains the page names and TPage instances defined for the notebook control.
`Align`	published	Specifies the placement of the control on its Parent control.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`Anchors`	published	The set of anchor definitions for this control.
`BiDiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`ParentBiDiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.

Methods

`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`ShowControl`	public	Displays the specified control (page object).
`IndexOf`	public	Gets the ordinal position in the list of pages for the specified page object.

Events

`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.