[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'ExtCtrls' (#lcl)

TNotebook

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TNotebook is a container for a series of pages placed together.

Declaration

Source position: extctrls.pp line 119

type TNotebook = class(TCustomControl)

public

  constructor Create(); override;

  

Constructor for the class instance.

  destructor Destroy; override;

  

Destructor for the class instance.

  procedure ShowControl(); override;

  

Displays the specified control (page object).

  function IndexOf();

  

Gets the ordinal position in the list of pages for the specified page object.

  property ActivePage: string; [r]

  

Gets the name for the active page object in the notebook control.

  property ActivePageComponent: TPage; [r]

  

Gets the TPage instance representing the active page in the notebook control.

  property Page []: TPage; [r]

  

Provides access to a page object in the notebook control by its ordinal position in the list of pages.

  property PageCount: Integer; [r]

  

Indicates the number of page objects defined for the notebook control.

published

  property PageIndex: Integer; [rw]

  

Ordinal position for the active page in the notebook control.

  property Pages: TStrings; [rws]

  

Contains the page names defined for the notebook control.

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property AutoSize: Boolean;

  

Allows automatic adjustment of the size for the control, according to its content.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BiDiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus; This is a good place for checking the finished user input.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property ParentBiDiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control.

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation when the user presses the Tab key.

  property TabStop: Boolean;

end;

Inheritance

TNotebook

  

TNotebook is a container for a series of pages placed together.

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components which have an associated widget.

|

TComponent

?

TObject

Description

TNotebook is a control which can hold a series of pages placed together. Only one page is shown at a time and this control is completely 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 controls. This control never has tabs. If you are looking for a control with tabs and 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'. 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 that Page.

See also

TPage

  

TPage: One of the pages in a tabbed Notebook.

Multi-Page Controls

  

MultiPageControls - controls that offer a selection of alternative pages for display.

How to use StdCtrls, ComCtrls or ExtCtrls.

  

How to use StdCtrls, ComCtrls or ExtCtrls.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.