TclForm

When you create forms in the Form designer at design time, they are implemented as descendants of TclForm. Forms can represent the application's main window, or dialog boxes. A form can contain other objects, such as TclButton, TclCheckBox, and TclComboBox objects.

Let's start with creating a new blank form. The parameter we need to use to create the form will be "TclForm". It is the variable name that we defined as "MyForm" in the example. You can define the variable name however you want. In this way, we define the form. We should write our codes in the Main Code section of our project.

var
MyForm:TclForm;

Now that we have done the definition process, we need to call and run it in the application. In this way, as soon as the project is clicked, an empty form page will appear.

begin
MyForm := TclForm.Create(Self);
MyForm.Run;
end;

After that, you can make your designs suitable for your project in the Form.

Output:
File:FormCreating.png

Form Background Property

In the project, it is possible to add a picture to the background of the form, add a single color or more than one color to give it a gradient feature. So how can we do this?
A form must be defined for this. Then the necessary parameters to add a picture and color for the form background;
For color: SetFormColor(‘1.color’,’2.color’,clGParam)

Color parameters:

clGNone: Used for uniform color

clGVertical: It gradients vertically.

clGHorizontal: It makes a horizontal gradient.

clGCross: It makes a diagonal gradient.

For image: SetFormBGImage(‘imageURL’)
Let's activate the form background feature by adding a single color.

var
MyForm:TclForm;

begin
MyForm := TclForm.Create(Self);
MyForm.SetFormColor('#CBEDD5','',clGNone);
MyForm.Run;

end;

Output:
File:FormColor.png

Now let's add two colors into the form. For this, you can just make the "clGNone" field one of the parameters clGVertical-clGHorizontal-clGCross and add the second color. You can use it by defining it this way.

var
MyForm:TclForm;

begin
MyForm := TclForm.Create(Self);
MyForm.SetFormColor('#CBEDD5','#E6E2C3',clGVertical);
MyForm.Run;

end; 

Output:
File:FormColorVertical.png

We learned the form coloring feature. Now let's add an image to the form background. We will use the "SetFormBGImage" parameter for this and you only need to enter the url address of the image.

var
MyForm:TclForm;

begin
MyForm := TclForm.Create(Self);
MyForm.SetFormBGImage('https://clomosy.com/theme/SurveyStyle5.png');

MyForm.Run;

end;

Output:
File:FormBGImage.png

Object Types

Fields

Feature	Use of	Definition
BtnFormMenu	TclButton(MainForm.clFindComponent('BtnFormMenu')).Visible := False; //True TclButton(MainForm.clFindComponent('BtnFormMenu')).Click;	The visibility of the menu button on the form can be toggled, and its clickability can be enabled or disabled.
BtnFormPictureShare	TclButton(MainForm.clFindComponent('BtnFormPictureShare')).Visible := False; //True TclButton(MainForm.clFindComponent('BtnFormPictureShare')).Click;	The visibility of the share button is enabled, and clicking it can be triggered.
BtnGoBack	TclButton(MainForm.clFindComponent('BtnGoBack')).Visible := False;//True TclButton(MainForm.clFindComponent('BtnGoBack')).Click;	The visibility of the back button on the form can be toggled, and its clickability can be enabled or disabled.
clCanClose	MainForm.clCanClose := false; //True	If this method is given a value of false, the form will not close; if value of true, the form can be closed.
clsender	TCLLayout(MainForm.Clsender).Hint; TColumn(MyForm.clSender).Index (ex.)	It is a parameter commonly used in event handlers. clSender represents the object that triggered the event. In an example usage, in the event of a TclLayout click, clSender would represent the hint value of this button object.
clVKBoundsHeight	MyForm.clVKBoundsHeight	It returns the keyboard's boundary height.
clVKBoundsLeft	MyForm.clVKBoundsLeft	It returns the left boundary value of the keyboard.
clVKBoundsRight	MyForm.clVKBoundsRight	It returns the right boundary value of the keyboard.
clVKBoundsWidth	MyForm.clVKBoundsWidth	It returns the keyboard's boundary width.
clVKVisible	MyForm.clVKVisible := False;	The visibility of the keyboard is set.
FormClListView	TClListView(MyGuideForm.clFindComponent('FormClListView'));	It returns the ListView pre-existing in the GuideForm.
NewObject	MyForm.NewObject := TBasisControl(ztPanel); MyForm.NewObject.Align := alCenter;	A new object can be created on the form.

Methods

Feature	Use of	Definition
AddNewButton	MyForm.AddNewButton(MyForm,'testBtn','Test Button Caption');	It is used to add a new button component.
AddNewChart	MyForm.AddNewChart(MyForm,'testChart','Clomosy Inc');	It is used to add a new chart component.
AddNewCheckBox	MyForm.AddNewCheckBox(MyForm,'testCheckBox','Test CheckBox Caption');	It is used to add a new checkbox component.
AddNewComboBox	MyForm.AddNewComboBox(testLayout,'testCombo');	It is used to add a new comboBox component.
AddNewEdit	MyForm.AddNewEdit(MyForm,'testEdt','Test Edit Message');	It is used to add a new edit component.
AddNewEvent	MyForm.AddNewEvent(testBtn,tbeOnClick,'BtnOnClick');	It is used to give a component the ability to be clicked.
AddNewExpander	MyForm.AddNewExpander(MyForm,'MyExpander1','');	It is used to give a component the ability to be clicked.
AddNewHorzScrollBox	MyForm.TclHorzScrollBox(MyForm,'TestHorz');	It is used to add a new horz scrollbox component.
AddNewImage	MyForm.AddNewImage(MyForm,'testImg');	It is used to add a new image component.
AddNewLabel	MyForm.AddNewLabel(MyForm,'testLabel','Test Label Caption');	It is used to add a new label component.
AddNewLayout	MyForm.AddNewLayout(MyForm,'testLayout');	It is used to add a new layout component.
AddNewListView	MyForm.AddNewListView(MyForm,'testListview');	It is used to add a new listview component.
AddNewMemo	MyForm.AddNewMemo(MyForm,'noteMemo','Test Memo Message');	It is used to add a new memo component.
AddNewMenuFrame	MainForm.AddNewMenuFrame(MainForm,'tstmenuFrame');	It is used to add a new menu component.
AddNewMQTTConnection	MyForm.AddNewMQTTConnection(MyForm,'MyMQTT');	Mqtt connections are established.
AddNewNumberBox	MainForm.AddNewNumberBox(MainForm,'tstNumberBox');	It is used to add a new numberbox component.
AddNewPanel	MyForm.AddNewPanel(MyForm,'testPanelRow',);	It is used to add a new panel component.
AddNewProButton	MyForm.AddNewProButton(MyForm,'testBtn','Click');	It is used to add a new pro button component.
AddNewProDateEdit	MyForm.AddNewProDateEdit(MyForm,'testDate');	It is used to add a new date selection and editing component.
AddNewProEdit	MyForm.AddNewProEdit(MyForm,'testEdit','Phone Number');	It is used to add a new pro edit component.
AddNewProImage	MyForm.AddNewProImage(MyForm,'testImg');	It is used to add a new pro image component.
AddNewProLabel	MyForm.AddNewProLabel(MyForm,'testLabel','User Name :');	It is used to add a new pro label component.
AddNewProListView	MyForm.AddNewProListView(MyForm,'testListview');	It is used to add a new pro listview component.
AddNewProListViewDesignerPanel	MyForm.AddNewProListViewDesignerPanel(testListview,'testDesignerPanel');	It is used to add a new pro listview designer panel component.
AddNewProPanel	MyForm.AddNewProPanel(MyForm,'testPanel');	It is used to add a new pro panel component.
AddNewProSearchEdit	MyForm.AddNewProSearchEdit(MyForm,'searchEdt','Search...');	It is used to add a new pro search edit component.
AddNewQRCodeGenerator	MyForm.AddNewQRCodeGenerator(MyForm,'QRGen','QRGen Caption');	It is used to add a new QRCode generator component.
AddNewRadioButton	MyForm.AddNewRadioButton(MyForm,'testRadio','RadioButton Caption');	It is used to add a new radio button component.
AddNewRadioGroup	MainForm.AddNewRadioGroup(MainForm,'testRadioGrp','Group Caption');	It is used to add a new radio group component.
AddNewSensorsMotion	MainForm.AddNewSensorsMotion(MainForm,'testSensor');	It is used to add a new sensors motion component.
AddNewSwitch	MainForm.AddNewSwitch(MainForm,'testSwitch');	It is used to add a new switch component.
AddNewTimer	MyForm.AddNewTimer(MyForm,'GetTimer',1000);	It is used to add a new timer component.
AddNewVertScrollBox	MyForm.AddNewVertScrollBox(MyForm,'Test');	It is used to add a new vert scrollbox component.
AddNewWebBrowser	MyForm.AddNewWebBrowser(MyForm,'xWeb');	It is used to add a new web browser component.
BtnFormMenuClick	MainForm.BtnFormMenuClick(self);	When triggered, it opens the menu button of the form.
BtnGoBackClick	MainForm.BtnGoBackClick(self);	When triggered, the back button of the form becomes active and the form closes.
CallBarcodeReader	MyForm.CallBarcodeReader(testLabel);	The data inside the barcode is read and transferred to the 'testLabel' as in the example.
CallBarcodeReaderWithScript	MainForm.CallBarcodeReaderWithScript(testLabel,'procTest');	After reading the barcode, it writes the data into the "testLabel" as shown in the example. Following this, it goes to the trigger field "procTest".
clDateTimeToSQLStr	dateSql := MainForm.clDateTimeToSQLStr(Now);	Using the function, you can convert a TclDateTime value into a format that can be used in an SQL query.
clFindComponent	TclProButton(MyForm.clFindComponent('BtnGoBack')).Click; TclButton(MyGuideForm.clFİndComponent(’butonAdi’).Visible :=False	The function allows you to find a specific component under a form or component.
clGetChild	MainForm.clGetChild(testVertScrll);	It is added as a subelement of the used form.
clGetChildEx	MainForm.clGetChildEx(exBtn,testVertScrll);	It is used when a component is desired to be assigned as a subelement of a component on the form.
clWidth	MainForm.clWidth	The width of the form is reached.
clHide	MainForm.clHide;	Form hiding is performed.
clSetCaption	MainForm.clSetCaption('newCaption');	Changes the title of the form
clShow	MainForm.clShow;	The form is made visible.
clSQLDateTimeToDateTime	DateTimeValue := MainForm.clSQLDateTimeToDateTime(SQLStrDate);	It is used to convert a date in SQL format to Clomosy's TclDateTime format.
clHeight	MainForm.clHeight	The height of the form is reached.

Sample:
Music application home screen design example has been made. Here, a simple design was made by adding a picture to the background. In this way, you can create design screens suitable for the project you want.
Code:

var
MyForm:TclForm;
testImg : TclImage;
testBtn : TclProButton;
testLabel : TclLabel;

procedure BtnOnClick
begin
  ShowMessage('LISTEN');
end;

begin
MyForm := TclForm.Create(Self);

testLabel:= MyForm.AddNewLabel(MyForm,'testLabel','MUSIC APP');
testLabel.StyledSettings := ssFamily;
testLabel.TextSettings.Font.Size:=60;
testLabel.TextSettings.FontColor := clAlphaColor.clHexToColor('#FAF8F1');
testLabel.Align := alTop;
testLabel.Margins.Left:= 30;
testLabel.Margins.Top:= 50; 
testLabel.Height := 70;
testLabel.Width := 150;
MyForm.SetFormBGImage('https://cdn.wallpapersafari.com/65/32/GhZHFt.png');

testImg:= MyForm.AddNewImage(MyForm,'testImg');
testImg.Align := alTop;
testImg.Height := 120;
testImg.Width := 120;
testImg.Margins.Top:=130;
testImg.Margins.Left:=40;
MyForm.setImage(testImg,'https://cdn-icons-png.flaticon.com/128/2753/2753289.png');

testBtn := MyForm.AddNewProButton(MyForm,'testBtn','');
clComponent.SetupComponent(testBtn,'{"Align" : "Bottom","MarginBottom":50,"MarginLeft":30,"Width" :110,"Height":90}');
  
MyForm.SetImage(testBtn,'https://pngimage.net/wp-content/uploads/2018/06/seta-png-branca-4-300x200.png'); 
MyForm.AddNewEvent(testBtn,tbeOnClick,'BtnOnClick');
MyForm.Run;
end;

Output

Also See

• Virtual Keyboard