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

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

Adds a ToolButton item to the PagedTools collection, returning a pointer to the Item containing the button. Re-draw is automated.

DELPHI EXAMPLES

var MyPagedTools_Item : TADVANCE_PagedTools_Item; // Referring to a page by PageIndex: MyPagedTools_Item := MyCompositePageModule.PM2_ToolsTop.Pages[PageIndex].Toolbar.PagedTools.AddButtonItem; // Referring to a page by name: MyPagedTools_Item := MyPagedToolbarPage.Toolbar.PagedTools.AddButtonItem;

C++ EXAMPLES

// Referring to a page by PageIndex: TADVANCE_PagedTools_Item * pMyPagedTools_Item = MyCompositePageModule->PM2_ToolsTop->Pages[PageIndex]->Toolbar->PagedTools->AddButtonItem ( ) ; // Referring to a page by name: TADVANCE_PagedTools_Item * pMyPagedTools_Item = MyPagedToolbarPage->Toolbar->PagedTools->AddButtonItem ( ) ;

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

Deletes the PagedTools item at Index. Re-draw is automated.

DELPHI EXAMPLE

procedure TForm1. T1_PM5_ToolsBot_DeleteFirstButton(Sender: TObject); begin if ((T1.PM5_ToolsBot.FocusedPage <> nil) and (TADVANCE_Page_PagedTools(T1.PM5_ToolsBot.FocusedPage).Toolbar.PagedTools.Count > 0)) then TADVANCE_Page_PagedTools(T1.PM5_ToolsBot.FocusedPage).Toolbar.PagedTools.DeleteButtonItem(0); end;

C++ EXAMPLE

void __fastcall TForm1 :: T1_PM5_ToolsBot_DeleteFirstButton ( TObject * Sender ) { if ( T1->PM5_ToolsBot->FocusedPageIsAssignedAndNotNil ( ) ) { TADVANCE_Page_PagedTools * pPage = dynamic_cast < TADVANCE_Page_PagedTools * > ( T1->PM5_ToolsBot->FocusedPage ) ; if ( pPage ) if ( 0 < pPage->Toolbar->PagedTools->Count ) { pPage->Toolbar->PagedTools->DeleteButtonItem ( 0 ) ; } } }

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 MyPagedTools_Item : TADVANCE_PagedTools_Item; MyPagedTools_Item.Move(7, 0);

C++ EXAMPLE

TADVANCE_PagedTools_Item * pMyPagedTools_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

A TADVANCE_PagedTools_Item wraps each PagedTool™ of the Paged Toolbar™.

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 PMInterface.ToolButton_ProportionalSpacerWidthPercent times Page.Toolbar.ToolWidth (if Page.Toolbar.Captions_Visible is false) or Page.Toolbar.ToolWidth_Captions_Visible (if Page.Toolbar.Captions_Visible is true). 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 PopupMenu: TPopupMenu read FPopupMenu write SetPopupMenu;
__property Menus::TPopupMenu* PopupMenu = {read=FPopupMenu, write=SetPopupMenu};

Button PopupMenu.

property RefDescriptor : String read FRefDescriptor write FRefDescriptor;
__property AnsiString RefDescriptor = {read=FRefDescriptor, write=FRefDescriptor};

Intended for manual identification in the IDE. Can also be used for programmatic identification or any other desirable purpose, as RefDescriptor is not processed by UPC™ operations.

property User_GroupID: Integer read FUser_GroupID write FUser_GroupID;
__property int User_GroupID = {read=FUser_GroupID, write=FUser_GroupID, nodefault};

Provided for developer purposes such as numerically coded security. User_GroupID is not processed by UPC™ operations.

property Visible; (Boolean)
__property Visible ; (bool)

Button Visible.