Ultimate Page Control Suite™ Win32 | Delphi™ | C++Builder™; D.03. TADVANCE

Left: Main TADVANCE_PM04_DataMasterUPA FocusControl™ (top), and FocusControl™s of embedded page modules left-aligned. AuxTools™ are integral with the FocusControl™, which can be left, top or right aligned, or hidden. Example AuxTools™ are seen at top right of the main FocusControl™ and to the right of the FocusButtons of the bottom Paged Related Controls and Paged Toolbar regions.

TADVANCE_FocusControlInterface (FocusControl) in the Object Inspector.

A TADVANCE_FocusControlInterface belongs to each TADVANCE_PMInterface, and configures the FocusControl™ and integral AuxTools™ collection. Paths to FocusControl members take the form,

PROPERTIES

property AuxTools : TADVANCE_AuxTools_Collection read FAuxTools write FAuxTools;
__property TADVANCE_AuxTools_Collection* AuxTools = {read=FAuxTools, write=FAuxTools};

Developer-defined, managed collection of auxiliary tools, allowing developers to readily extend module functionality. Administered by the AuxTools™ property editor at design time. AuxTools™ are drawn to the right of the FocusButton when the FocusControl™ is aligned left or top, or to the left of the FocusButton when the FocusControl is aligned right.

GLOBAL AuxTools™ PROPERTIES

Global AuxTools™ properties allow you to apply uniform configuration values to the entire AuxTools™ collection.

property AuxTools_Captions_Visible: Boolean read FAuxTools_Captions_Visible write SetAuxTools_Captions_Visible;
__property bool AuxTools_Captions_Visible = {read=FAuxTools_Captions_Visible, write=SetAuxTools_Captions_Visible, nodefault};

Sets AuxTool.Caption.Visible. Globally applied to the AuxTools™ collection.

property AuxTools_DisappearAtWidthLessThan : Integer read FAuxTools_DisappearAtWidthLessThan write SetAuxTools_DisappearAtWidthLessThan default 26;
__property int AuxTools_DisappearAtWidthLessThan = {read=FAuxTools_DisappearAtWidthLessThan, write=SetAuxTools_DisappearAtWidthLessThan, default=26};

Preserves FocusButton visibility by causing AuxTools™ to disappear when FocusButton.Width < AuxTools_DisappearAtWidthLessThan.

property AuxTools_Font: TFont read FAuxTools_Font write SetAuxTools_Font;
__property Graphics::TFont* AuxTools_Font = {read=FAuxTools_Font, write=SetAuxTools_Font};

Globally applied to the Fonts of the AuxTools™ collection.

property AuxTools_Layout: TButtonLayout read FAuxTools_Layout write SetAuxTools_Layout default blGlyphLeft;
__property Buttons::TButtonLayout AuxTools_Layout = {read=FAuxTools_Layout, write=SetAuxTools_Layout, default=0};

AuxToolbutton.Layout. Globally applied to the AuxTools™ collection.

property AuxTools_Margin: Integer read FAuxTools_Margin write SetAuxTools_Margin default -1;
__property int AuxTools_Margin = {read=FAuxTools_Margin, write=SetAuxTools_Margin, default=-1};

AuxToolbutton.Margin. Globally applied to the AuxTools™ collection when AuxTools_Captions_Visible is false.

property AuxTools_Margin_Captions_Visible: Integer read FAuxTools_Margin_Captions_Visible write SetAuxTools_Margin_Captions_Visible default -1;
__property int AuxTools_Margin_Captions_Visible = {read=FAuxTools_Margin_Captions_Visible, write=SetAuxTools_Margin_Captions_Visible, default=-1};

AuxToolbutton.Margin. Globally applied to the AuxTools™ collection when AuxTools_Captions_Visible is true.

property AuxTools_ShowHint: Boolean read FAuxTools_ShowHint write SetAuxTools_ShowHint default True;
__property bool AuxTools_ShowHint = {read=FAuxTools_ShowHint, write=SetAuxTools_ShowHint, default=1};

AuxToolbutton.ShowHint. Globally applied to the AuxTools™ collection.

property AuxTools_Spacing: Integer read FAuxTools_Spacing write SetAuxTools_Spacing default 4;
__property int AuxTools_Spacing = {read=FAuxTools_Spacing, write=SetAuxTools_Spacing, default=4};

AuxToolbutton.Spacing. Globally applied to the AuxTools™ collection.

property AuxTools_Transparent: Boolean read FAuxTools_Transparent write SetAuxTools_Transparent default True;
__property bool AuxTools_Transparent = {read=FAuxTools_Transparent, write=SetAuxTools_Transparent, default=1};

AuxToolbutton.Transparent. Globally applied to the AuxTools™ collection.

property AuxTools_Width: Integer read FAuxTools_Width write SetAuxTools_Width;
__property int AuxTools_Width = {read=FAuxTools_Width, write=SetAuxTools_Width, nodefault};

AuxToolbutton.Width. Globally applied to the AuxTools™ collection when AuxTools_Captions_Visible is false. AuxToolbutton.Height = FocusButton.Height.

property AuxTools_Width_Captions_Visible: Integer read FAuxTools_Width_Captions_Visible write SetAuxTools_Width_Captions_Visible default 80;
__property int AuxTools_Width_Captions_Visible = {read=FAuxTools_Width_Captions_Visible, write=SetAuxTools_Width_Captions_Visible, default=80};

AuxToolbutton.Width. Globally applied to the AuxTools™ collection when AuxTools_Captions_Visible is true. AuxToolbutton.Height = FocusButton.Height.

PROPERTIES CONTINUED...

property FC_Align : TADVANCE_FC_Align read FFC_Align write SetFC_Align;
__property TADVANCE_FC_Align FC_Align = {read=FFC_Align, write=SetFC_Align, nodefault};

TADVANCE_FC_Align = (FC_AlignTop, FC_AlignLeft, FC_AlignRight);
enum TADVANCE_FC_Align { FC_AlignTop, FC_AlignLeft, FC_AlignRight };

FocusControl.Align. Composite embedded modules are aligned top or bottom. If the module itself is aligned top, bottom or none, then Page.Height is automatically maintained when FC_Align is toggled between top and side values.

DELPHI EXAMPLE

procedure TForm1.
RadioGroup_FC_AlignClick(Sender: TObject);
     begin
     case RadioGroup_FC_Align.ItemIndex of
          0 : begin
              T1.PM2_ToolsTop.FocusControl.FC_Align := FC_AlignLeft;
              T1.PM3_RelTop.FocusControl.FC_Align   := FC_AlignLeft;
              T1.PM4_RelBot.FocusControl.FC_Align   := FC_AlignLeft;
              T1.PM5_ToolsBot.FocusControl.FC_Align := FC_AlignLeft;
              T1.PM6_Status.FocusControl.FC_Align   := FC_AlignLeft;
              end;
          1 : begin
              T1.PM2_ToolsTop.FocusControl.FC_Align := FC_AlignTop;
              T1.PM3_RelTop.FocusControl.FC_Align   := FC_AlignTop;
              T1.PM4_RelBot.FocusControl.FC_Align   := FC_AlignTop;
              T1.PM5_ToolsBot.FocusControl.FC_Align := FC_AlignTop;
              T1.PM6_Status.FocusControl.FC_Align   := FC_AlignTop;
              end;
          2 : begin
              T1.PM2_ToolsTop.FocusControl.FC_Align := FC_AlignRight;
              T1.PM3_RelTop.FocusControl.FC_Align   := FC_AlignRight;
              T1.PM4_RelBot.FocusControl.FC_Align   := FC_AlignRight;
              T1.PM5_ToolsBot.FocusControl.FC_Align := FC_AlignRight;
              T1.PM6_Status.FocusControl.FC_Align   := FC_AlignRight;
              end;
          end;
     end;

C++ EXAMPLE

void __fastcall TForm1 :: RadioGroup_FC_AlignClick ( TObject * Sender )
     {
     switch ( RadioGroup_FC_Align->ItemIndex )
     	{
          case 0 :
               {
               T1->PM2_ToolsTop->FocusControl->FC_Align = FC_AlignLeft ;
               T1->PM3_RelTop->FocusControl->FC_Align   = FC_AlignLeft ;
               T1->PM4_RelBot->FocusControl->FC_Align   = FC_AlignLeft ;
               T1->PM5_ToolsBot->FocusControl->FC_Align = FC_AlignLeft ;
               T1->PM6_Status->FocusControl->FC_Align   = FC_AlignLeft ;
               break ;
               }
          case 1 :
               {
               T1->PM2_ToolsTop->FocusControl->FC_Align = FC_AlignTop ;
               T1->PM3_RelTop->FocusControl->FC_Align   = FC_AlignTop ;
               T1->PM4_RelBot->FocusControl->FC_Align   = FC_AlignTop ;
               T1->PM5_ToolsBot->FocusControl->FC_Align = FC_AlignTop ;
               T1->PM6_Status->FocusControl->FC_Align   = FC_AlignTop ;
               break ;
               }
          case 2 :
               {
               T1->PM2_ToolsTop->FocusControl->FC_Align = FC_AlignRight ;
               T1->PM3_RelTop->FocusControl->FC_Align   = FC_AlignRight ;
               T1->PM4_RelBot->FocusControl->FC_Align   = FC_AlignRight ;
               T1->PM5_ToolsBot->FocusControl->FC_Align = FC_AlignRight ;
               T1->PM6_Status->FocusControl->FC_Align   = FC_AlignRight ;
               break ;
               }
          default :
          	{
               break ;
               }
          }
     }

property FocusButton_Caption_Visible : Boolean read FFocusButton_Caption_Visible write SetFocusButton_Caption_Visible;
__property bool FocusButton_Caption_Visible = {read=FFocusButton_Caption_Visible, write=SetFocusButton_Caption_Visible, nodefault};

FocusButton.Caption.Visible. If True and FC_Align = FC_AlignLeft or FC_AlignRight, then FocusButton.Width is configured to FocusButton_Width_LeftOrRightAligned. If False and FC_Align = FC_AlignLeft or FC_AlignRight, then FocusButton.Width is configured to FocusButton_Width_LRAlignedCaptionNotVisible.

DELPHI EXAMPLE

C++ EXAMPLE

property FocusButton_CharSpacing : TADVANCE_CharSpacing read FFocusButton_CharSpacing write SetFocusButton_CharSpacing;
__property TADVANCE_CharSpacing FocusButton_CharSpacing = {read=FFocusButton_CharSpacing, write=SetFocusButton_CharSpacing, nodefault};

TADVANCE_CharSpacing = (csNormal, cs2X, cs3X, cs4X, cs5X);
enum TADVANCE_CharSpacing { csNormal, cs2X, cs3X, cs4X, cs5X };

Applies character spacing to the FocusButton™ Caption. For effect, or to make smaller fonts more legible.

property FocusButton_Height_TopAligned : Integer read FFocusButton_Height_TopAligned write SetFocusButton_Height_TopAligned;
__property int FocusButton_Height_TopAligned = {read=FFocusButton_Height_TopAligned, write=SetFocusButton_Height_TopAligned, nodefault};

FocusButton.Height when FC_Align = FC_AlignTop. When aligned to either side, Height = Module.ClientHeight.

property FocusButton_Hint_NoSizing : String read FFocusButton_Hint_NoSizing write SetFocusButton_Hint_NoSizing;
__property AnsiString FocusButton_Hint_NoSizing = {read=FFocusButton_Hint_NoSizing, write=SetFocusButton_Hint_NoSizing};

Prescribes the FocusButton™ hint when the Sizing Window is not deployed (when no SizingEvents are assigned to the PMInterface).

property FocusButton_Hint_Sizing : String read FFocusButton_Hint_Sizing write SetFocusButton_Hint_Sizing;
__property AnsiString FocusButton_Hint_Sizing = {read=FFocusButton_Hint_Sizing, write=SetFocusButton_Hint_Sizing};

Prescribes the FocusButton™ hint when the Sizing Window is deployed (when SizingEvents are assigned to the PMInterface).

property FocusButton_PrefixString : String read FFocusButton_PrefixString write SetFocusButton_PrefixString;
__property AnsiString FocusButton_PrefixString = {read=FFocusButton_PrefixString, write=SetFocusButton_PrefixString};

Prescribes a FocusButton™ caption prefix such as, "FOCUS : ". The navigation captions of each page are appended to FocusButton_PrefixString.

property FocusButton_Width_LeftOrRightAligned : Integer read FFocusButton_Width_LeftOrRightAligned write SetFocusButton_Width_LeftOrRightAligned;
__property int FocusButton_Width_LeftOrRightAligned = {read=FFocusButton_Width_LeftOrRightAligned, write=SetFocusButton_Width_LeftOrRightAligned, nodefault};

Prescribes FocusButton.Width when FC_Align = FC_AlignLeft or FC_AlignRight and FocusButton_Caption_Visible = True. The original value is 250.

property FocusButton_Width_LRAlignedCaptionNotVisible : Integer read FFocusButton_Width_LRAlignedCaptionNotVisible write SetFocusButton_Width_LRAlignedCaptionNotVisible;
__property int FocusButton_Width_LRAlignedCaptionNotVisible = {read=FFocusButton_Width_LRAlignedCaptionNotVisible, write=SetFocusButton_Width_LRAlignedCaptionNotVisible, nodefault};

Prescribes FocusButton.Width when FC_Align = FC_AlignLeft or FC_AlignRight and FocusButton_Caption_Visible = False. The original value (and proper value to center the glyph) is 44.

property Font : TFont read FFont write FFont;
__property Graphics::TFont* Font = {read=FFont, write=FFont};

FocusButton.Caption.Font. The value is also applied to embedded modules, except the Style and Size subproperties.

property EmbeddedModules_FontSizeDifferential : Integer read FEmbeddedModules_FontSizeDifferential write SetEmbeddedModules_FontSizeDifferential default 0;
__property int EmbeddedModules_FontSizeDifferential = {read=FEmbeddedModules_FontSizeDifferential, write=SetEmbeddedModules_FontSizeDifferential, default=0};

EmbeddedModule.FocusButton.Caption.Font.Size = FocusButton.Caption.Font.Size + EmbeddedModules_FontSizeDifferential.

property EmbeddedModules_Font_Style : TFontStyles read FEmbeddedModules_Font_Style write SetEmbeddedModules_Font_Style;
__property Graphics::TFontStyles EmbeddedModules_Font_Style = {read=FEmbeddedModules_Font_Style, write=SetEmbeddedModules_Font_Style, nodefault}

Prescribes the EmbeddedModule.FocusButton.Caption.Font.Style (which is applied to the further/embedded modules of composite UPC™ page controls).

property PageNavCaptions_Number : Boolean read FPageNavCaptions_Number write SetPageNavCaptions_Number default False;
__property int EmbeddedModules_FontSizeDifferential = {read=FEmbeddedModules_FontSizeDifferential, write=SetEmbeddedModules_FontSizeDifferential, default=-2};

Applies or rescinds automated page caption numbering.

DELPHI EXAMPLE

C++ EXAMPLE

property PM : TADVANCE_PM read PtrPM;
__property TADVANCE_PM* PM = {read=PtrPM};

Read-only pointer to the underlying, visual page module (root layer).

property PMInterface : TADVANCE_PMInterface read PtrPMInterface;
__property TADVANCE_PMInterface* PMInterface = {read=PtrPMInterface};

Read-only pointer to the PMInterface of the internalized page module.

property Visible : Boolean read FVisible write SetVisible;
__property bool Visible = {read=FVisible, write=SetVisible, nodefault};

FocusControl.Visible.

• PRECEDING

D.02. TADVANCE_ColorScheme

NEXT •

D.04. TADVANCE_IObj_LogoPanel

Best viewed in Mozilla Firefox™.