Ultimate Page Control Suite™ Win32 | Delphi™ | C++Builder™

TOwnedCollection

TADVANCE_PIDCollection

TADVANCE_AuxTools_Collection

TADVANCE_PageGroup_Collection

TADVANCE_ToolCollection__Prot

TADVANCE_MasterTools_Collection

TADVANCE_PagedTools_Collection

Example AuxTools™ (right, top). TADVANCE_AuxTools_Collections are drawn to the right of the FocusButton when the FocusControl™ is top or left aligned, and to the left of the FocusButton when the FocusControl™ is right-aligned.

Auxiliary tool collections allow you to extend the functionality of UPC™ page modules simply by adding the tools you need. A managed TADVANCE_AuxTools_Collection belongs to each FocusControl™, and is administered at design time by the AuxTools™ property editor (immediately below).

function AddButtonItem: TADVANCE_AuxTools_Item;
TADVANCE_AuxTools_Item* __fastcall AddButtonItem(void);

Adds a button to the Auxiliary Focus Tools of the FocusControl™, returning a pointer to the Item containing the button. Re-draw is automated.

DELPHI EXAMPLE

MyNewAuxTools_Item := T1.PM1_Main.FocusControl.AuxTools.AddButtonItem;

C++ EXAMPLE

TADVANCE_AuxTools_Item * pMyNewAuxTools_Item = T1->PM1_Main->FocusControl->AuxTools->AddButtonItem ( ) ;

procedure DeleteButtonItem(Index: Integer);
void __fastcall DeleteButtonItem(int Index);

Deletes the AuxTools™ item at Index. Re-draw is automated.

DELPHI EXAMPLE

T1.PM1_Main.FocusControl.AuxTools.DeleteButtonItem(Index);

C++ EXAMPLE

T1->PM1_Main->FocusControl->AuxTools->DeleteButtonItem ( Index ) ;

function Move(CurIndex, NewIndex: Integer): Integer;
int __fastcall Move(int CurIndex, int NewIndex);

Moves a ToolButton from CurIndex to NewIndex. Re-draw is automated.

DELPHI EXAMPLE

var MyAuxTools_Item : TADVANCE_AuxTools_Item; MyAuxTools_Item.Move(7, 0);

C++ EXAMPLE

TADVANCE_AuxTools_Item * pMyAuxTools_Item->Move ( 7, 0 ) ;

function PID_GetIndex(APID: Integer): Integer; virtual;
virtual int __fastcall PID_GetIndex(int APID);

Returns the index of an item if Item.PID = APID; -1 is returned if no match is found.

DELPHI EXAMPLE — REFERRING TO PID TO PROCESS ITEM BY INDEX OF ITEM

var IndexOfMyPIDItem, MyPIDCollection : Integer; IndexOfMyPIDItem := MyPIDCollection.PID_GetIndex ( MyPIDReferenceInteger ) ; if ( -1 < IndexOfMyPIDItem ) then Process ( MyPIDCollection.Items[ IndexOfMyPIDItem ].[etc.] ) ;

C++ EXAMPLE — REFERRING TO PID TO PROCESS ITEM BY INDEX OF ITEM

int IndexOfMyPIDItem = MyPIDCollection->PID_GetIndex ( MyPIDReferenceInteger ) ; if ( -1 < IndexOfMyPIDItem ) Process ( MyPIDCollection->Items[ IndexOfMyPIDItem ].[etc.] ) ;

function PID_GetItem(APID: Integer): TADVANCE_PIDItem; virtual;
virtual TADVANCE_PIDItem* __fastcall PID_GetItem(int APID);

Returns a pointer to an item if Item.PID = APID; or nil if no match is found.

DELPHI EXAMPLE — REFERRING TO PID TO PROCESS ITEM

var TempPIDItem : TADVANCE_PIDItem; TempPIDItem := MyPIDCollection.PID_GetItem(MyPIDReferenceInteger);

C++ EXAMPLE — REFERRING TO PID TO PROCESS ITEM

TADVANCE_PIDItem * TempPIDItem = MyPIDCollection->PID_GetItem ( MyPIDReferenceInteger ) ;

TCollectionItem

TADVANCE_PIDItem

TADVANCE_AuxTools_Item

TADVANCE_PageGroup_Item

TADVANCE_ToolCollectionItem__Prot

TADVANCE_MasterTools_Item

TADVANCE_PagedTools_Item

TADVANCE_AuxTools_Item wraps the individual AuxTool™ button. To operate on the item at design time, click the AuxTools™ property ellipsis of the FocusControl, select the item, and click CLOSE, Focus Selected in Object Inspector.

property OnClick: TNotifyEvent read FOnClick write SetOnClick;
__property Classes::TNotifyEvent OnClick = {read=FOnClick, write=SetOnClick};

Button.OnClick.

property OnDblClick: TNotifyEvent read FOnDblClick write SetOnDblClick;
__property Classes::TNotifyEvent OnDblClick = {read=FOnDblClick, write=SetOnDblClick};

Button.OnDblClick.

property OnMouseDown: TMouseEvent read FOnMouseDown write SetOnMouseDown;
__property Controls::TMouseEvent OnMouseDown = {read=FOnMouseDown, write=SetOnMouseDown};

Button.OnMouseDown.

property OnMouseMove: TMouseMoveEvent read FOnMouseMove write SetOnMouseMove;
__property Controls::TMouseMoveEvent OnMouseMove = {read=FOnMouseMove, write=SetOnMouseMove};

Button.OnMouseMove.

property OnMouseUp: TMouseEvent read FOnMouseUp write SetOnMouseUp;
__property Controls::TMouseEvent OnMouseUp = {read=FOnMouseUp, write=SetOnMouseUp};

Button.OnMouseUp.

property Caption: String read FCaption write SetCaption;
__property AnsiString Caption = {read=FCaption, write=SetCaption};

Button.Caption.

property Down: Boolean read FDown write SetDown default False;
__property bool Down = {read=FDown, write=SetDown, default=0};

Button.Down.

property Enabled: Boolean read FEnabled write SetEnabled default True;
__property bool Enabled = {read=FEnabled, write=SetEnabled, default=1};

Button.Enabled.

property Glyph: TBitmap read GetGlyph write SetGlyph;
__property Graphics::TBitmap* Glyph = {read=GetGlyph, write=SetGlyph};

Button.Glyph.

property GroupIndex: Integer read FGroupIndex write SetGroupIndex default 0;
__property int GroupIndex = {read=FGroupIndex, write=SetGroupIndex, default=0};

Button.GroupIndex.

property Hint: String read FHint write SetHint;
__property AnsiString Hint = {read=FHint, write=SetHint};

Button.Hint.

property IsPrecededBySpacer: Boolean read FIsPrecededBySpacer write SetIsPrecededBySpacer;
__property bool IsPrecededBySpacer = {read=FIsPrecededBySpacer, write=SetIsPrecededBySpacer, nodefault};

IsPrecededBySpacer declares the beginning of a group of buttons preceded by a spacer. The width of the spacer equals ToolButton_ProportionalSpacerWidthPercent times AuxTools_Width or AuxTools_Width_Captions_Visible (if AuxTools_Captions_Visible). IsPrecededBySpacer of the first button of the collection is ignored.

property NumGlyphs: TNumGlyphs read FNumGlyphs write SetNumGlyphs default 2;
__property Buttons::TNumGlyphs NumGlyphs = {read=FNumGlyphs, write=SetNumGlyphs, default=2};

Button.NumGlyphs.

property PID : Integer read FPID stored True;
__property int PID = {read=FPID, stored=true, nodefault};

AuxTools_Items are identified by a PID (Persistent ID) which endures across application sessions. PIDs allow you to code permanent references to TADVANCE_PIDItem.

property PopupMenu: TPopupMenu read FPopupMenu write SetPopupMenu;
__property Menus::TPopupMenu* PopupMenu = {read=FPopupMenu, write=SetPopupMenu};

Button.PopupMenu.