TclGuideForm

It is a customized guide form. With the customized guide, it returns only the data that is queried without accessing all the data. In another use case, when data selected from a page search needs to be transferred to the previous page, the "TclGuideForm" component is used.

Before using these features, the form must be initialized.
An object of the TclGuideForm class should be defined.

var
   GuideForm1 : TclGuideForm;

The defined object must be created using the "Create" function.

{
  GuideForm1 = TclGuideForm.Create(Self);
  GuideForm1.Run;
}

The features are provided in the table below.

Feature	Use of	Definition
ReturnItemData	GuideForm1.ReturnItemData = 'MAIN_TEXT';	The value of the desired field from the data clicked on in the list on the form page is retrieved and displayed in the next content. The name of the selected field must be written. In the example, the value from the "MAIN_TEXT" field is retrieved.
ReturnItemObject	GuideForm1.ReturnItemObject = edtListNumber;	The value returned from the previously selected field is passed. In the example, the data has been transferred to a TclEdit component named "edtListNumber".

Example

In this example, a TclForm will be created, containing a list view (TclListView), an interactive search field (TclProEdit), and a TclGuideForm to display data.

First, a SQLite database will be created with an "OperatingSystem" table, and sample data will be inserted into the table. When the user enters data into the search field and clicks the search button, the OnGuideQryClick event will be triggered, performing a database query based on the entered term.

The results of this query will be loaded into the list view, and when a user selects an item, a specific field (MAIN_TEXT) of that item will be transferred to an edit box (edtListNumber). The form will also include a title, layouts, and various components for user interaction. TclGuideForm will be used to display the search results and retrieve the selected data.

Key steps:

Let's set up our connection to the sqlite database.

Clomosy.DBSQLiteConnect(Clomosy.AppFilesPath + 'DBProductSales.db3', '');

After that, we need to add BasisGuide to reach the desired guide information. After that, we add a listView to the Guide form and connect it to our form.

mainListviewGuide = TClListView(MyGuideForm.clFindComponent('FormClListView'));
mainListviewGuide.Align = alClient;
mainListviewGuide.Visible = True;

After that, when we click on the button on the edit we wrote, it goes to the database and finds the value sought here and transfers it to the ListView.

void OnGuideQryClick;
var
  Qry : TClSQLiteQuery;
{
  try
    Qry = Clomosy.DBSQLiteQueryWith('SELECT model AS MAIN_TEXT,operating_system AS SUB_TEXT FROM OperatingSystem WHERE model LIKE '+QuotedStr('%'+searchGuideEdit.text+'%'));
    Qry.OpenOrExecute;
    if (Qry.Found)
    {
      mainListviewGuide.clLoadListViewDataFromDataset(Qry);
    }
    
  except
    ShowMessage('Exception class: '+LastExceptionClassName+' Exception Message: ' +LastExceptionMessage);
  } 
}

Finally, the Guide takes the "MAIN_TEXT" field of the clicked data from the form with the "ReturnItemData" parameter and sends it to the edit on the previous page with the "ReturnItemObject" parameter.

MyGuideForm.ReturnItemData = 'MAIN_TEXT';
MyGuideForm.ReturnItemObject = edtListNumber;

Example:

 var
  MyForm:TclForm;
  MyGuideForm : TclGuideForm;
  mainListviewGuide : TclListView;
  lblTitle,lblListNumber :TClLabel;
  edtListNumber : TclEdit;
  searchGuideEdit :TclProEdit;
  searchRehButton,btnListNumber : TClProButton;
  vertScrollBoxMain : TClVertScrollBox;
  lytContent,lytListNumber:TClLayout;
  searchRehLayout : TClLayout;
  
void Setup;
{
  vertScrollBoxMain = MyForm.AddNewVertScrollBox(MyForm,'vertScrollBoxMain');
  vertScrollBoxMain.Align = alClient;
  
  lytContent= MyForm.AddNewLayout(vertScrollBoxMain,'lytContent');
  lytContent.Align = alTop;
  lytContent.Height =700;
}
  
void SetCaptionName;
{
  lblTitle= MyForm.AddNewLabel(MyForm,'lblTitle','COUNT SCREEN');
  lblTitle.Align=alMostTop;
  lblTitle.Margins.Left=100;
  lblTitle.Height =30;
  lblTitle.StyledSettings = ssFamily;
  lblTitle.TextSettings.Font.Size= 20;
}
void GuideListView;
{
  mainListviewGuide = TClListView(MyGuideForm.clFindComponent('FormClListView'));
  mainListviewGuide.Align = alClient;
  mainListviewGuide.Visible = True;
}

void OnGuideQryClick;
var
  Qry : TClSQLiteQuery;
{
  try
    Qry = Clomosy.DBSQLiteQueryWith('SELECT model AS MAIN_TEXT,operating_system AS SUB_TEXT FROM OperatingSystem WHERE model LIKE '+QuotedStr('%'+searchGuideEdit.text+'%'));
    Qry.OpenOrExecute;
    if (Qry.Found)
    {
      mainListviewGuide.clLoadListViewDataFromDataset(Qry);
    }
    
  except
    ShowMessage('Exception class: '+LastExceptionClassName+' Exception Message: ' +LastExceptionMessage);
  } 
}
 
void GuideSearchView;
{
  searchRehLayout = MyGuideForm.AddNewLayout(MyGuideForm,'searchRehLayout');
  searchRehLayout.Align=ALTop;
  searchRehLayout.Height = 50;
  
  searchGuideEdit= MyGuideForm.AddNewProEdit(searchRehLayout,'searchGuideEdit','Search...');
  searchGuideEdit.Align=ALClient;
  searchGuideEdit.Height = 50;
  searchGuideEdit.Width = 180;
  searchGuideEdit.Margins.Top = 10;
  searchGuideEdit.clProSettings.IsRound = True;
  searchGuideEdit.clProSettings.RoundHeight = 10;
  searchGuideEdit.clProSettings.RoundWidth = 10;
  searchGuideEdit.clProSettings.BorderColor = clAlphaColor.clHexToColor('#be92e0');
  searchGuideEdit.clProSettings.BorderWidth = 2;
  searchGuideEdit.SetclProSettings(searchGuideEdit.clProSettings);
  
  searchRehButton= MyGuideForm.AddNewProButton(searchRehLayout,'searchRehButton','');
  searchRehButton.Align=ALRight;
  searchRehButton.Height = 40;
  searchRehButton.Width = 60;
  searchRehButton.clProSettings.IsRound = True;
  searchRehButton.clProSettings.RoundHeight = 10;
  searchRehButton.clProSettings.RoundWidth = 10;
  searchRehButton.clProSettings.BorderColor = clAlphaColor.clHexToColor('#be92e0');
  searchRehButton.clProSettings.BorderWidth = 2;
  searchRehButton.clProSettings.PictureSource = 'https://clomosy.com/demos/searchBtn.png';
  searchRehButton.SetclProSettings(searchRehButton.clProSettings);
  MyGuideForm.AddNewEvent(searchRehButton,tbeOnClick,'OnGuideQryClick');
}

void OnListBtnClick
{
  MyGuideForm = TclGuideForm.Create(Self);
  TClButton(MyGuideForm.ClFindComponent('BtnFormMenu')).Visible = False;
  GuideListView;
  GuideSearchView;
  MyGuideForm.ReturnItemData = 'MAIN_TEXT';
  MyGuideForm.ReturnItemObject = edtListNumber;
  MyGuideForm.Run;
}
 
void SetMainView;
{    
  lytListNumber        = MyForm.AddNewLayout(MyForm,'lytListNumber');
  lytListNumber.Align  = alTop;
  lytListNumber.Margins.Top = 10;
  lytListNumber.Height = 25;
  lytListNumber.Width  = 340;
  
  lblListNumber              = MyForm.AddNewLabel(lytListNumber,'lblListNumber','List Number:');
  lblListNumber.Align        = alMostLeft;
  lblListNumber.Width        = 140;
  lblListNumber.Margins.Left = 10;
  
  edtListNumber       = MyForm.AddNewEdit(lytListNumber,'edtListNumber','List Number');
  edtListNumber.Align = alLeft;
  edtListNumber.Width = 140;
  
  btnListNumber= MyForm.AddNewProButton(lytListNumber,'btnListNumber','');
  btnListNumber.Align = AlRight;
  btnListNumber.Width = 50;
  btnListNumber.Height = 60;
  btnListNumber.Margins.Right = 10;
  btnListNumber.clProSettings.IsRound = True;
  btnListNumber.clProSettings.RoundHeight = 10;
  btnListNumber.clProSettings.RoundWidth = 10;
  btnListNumber.clProSettings.BorderColor = clAlphaColor.clHexToColor('#be92e0');
  btnListNumber.clProSettings.BorderWidth = 2;
  btnListNumber.clProSettings.PictureSource = 'https://clomosy.com/demos/searchBtn.png';
  btnListNumber.SetclProSettings(btnListNumber.clProSettings);
  MyForm.AddNewEvent(btnListNumber,tbeOnClick,'OnListBtnClick');
}

   void SqLiteInsertData;
  {
    try
      Clomosy.DBSQLiteQuery.Sql.Text = '
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (1, ''Vista'',''Microsoft Windows'',''tablet'', 200);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''XP'',''Microsoft Windows'',''tablet'', 500);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''Alpha'',''Microsoft Windows'',''computer'', 104);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''Public Beta'',''MacOS'',''computer'', 400);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (2, ''Tiger'',''MacOS'',''tablet'', 350);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''Leopard'',''MacOS'',''computer'', 125);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (3, ''Lollipop'',''Android'',''mobile'', 325);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''Alpha'',''Android'',''tablet'', 123);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (4, ''Gnome'',''Pardus'',''computer'', 300);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''Raspberry'',''Pardus'',''computer'', 175);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (5, ''Tiger'',''MacOS'',''mobile'', 10);
    INSERT INTO OperatingSystem (id, model,operating_system,device_type, sales_figure) VALUES (6, ''Alpha'',''MacOS'',''ipad'', 104);';
      Clomosy.DBSQLiteQuery.OpenOrExecute;
      
      ShowMessage('Adding data to the table was successful!');
    except
     ShowMessage('Exception Class: '+LastExceptionClassName+' Exception Message: '+LastExceptionMessage);
    }
  }
  
  void SqLiteConnectionCreateTable;
  var
    TableExists: Boolean;
  {
    try
      Clomosy.DBSQLiteConnect(Clomosy.AppFilesPath + 'DBProductSales.db3', '');
 
      // Check if the table exists
      Clomosy.DBSQLiteQuery.Sql.Text = 'SELECT name FROM sqlite_master WHERE type="table" AND name="OperatingSystem";';
      Clomosy.DBSQLiteQuery.OpenOrExecute;
      
      // Check the results
      TableExists = not Clomosy.DBSQLiteQuery.Eof;
      
      // Create the table if it does not exist
      if not (TableExists)
      {
        Clomosy.DBSQLiteQuery.Sql.Text = 'CREATE TABLE OperatingSystem (
                                        	id INTEGER NOT NULL,
                                        	model TEXT NOT NULL,
                                        	operating_system TEXT NOT NULL,
                                        	device_type TEXT NOT NULL,
                                        	sales_figure INTEGER NOT NULL
                                          )';
        Clomosy.DBSQLiteQuery.OpenOrExecute;
        
        ShowMessage('Table successfully added to the database!');
        SqLiteInsertData;
      } else
      {
        ShowMessage('The Products table already exists.');
      }

    except
     ShowMessage('Exception Class: '+LastExceptionClassName+' Exception Message: '+LastExceptionMessage);
    }
  }

{
  MyForm = TclForm.Create(Self);
  MyForm.SetFormColor('#ffffff','#cebade',clGVertical);
  Setup;
  SetCaptionName;
  SetMainView;  
  SqLiteConnectionCreateTable;
  MyForm.Run;
}

Output:

• 

  MyForm Screen

• 

  MyGuideForm Screen

See Also

• Virtual Keyboard
• TclForm