From Clomosy Docs

No edit summary
No edit summary
 
(74 intermediate revisions by 2 users not shown)
Line 3: Line 3:
The properties of the Clomosy class gather data and behaviors together, enabling the design of complex projects in a more comprehensible manner.
The properties of the Clomosy class gather data and behaviors together, enabling the design of complex projects in a more comprehensible manner.


= General Features =
<div  class="alert alert-success" role="alert" data-bs-theme="light" style="border: 1px solid #ddd; padding: 16px; background-color: #e8f5e9; border-radius: 8px; box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);">
<ul>
<li>
<div class="green-learn-more">
[[#Account Information|Account Information:]]
</div>
The information for the developer account includes the company GUID, project GUID, and project name.
</li>
<li>
<div class="green-learn-more">
[[#User Account Information|User Account Information:]]
</div>
The user information data is being retrieved.
</li>
<li>
<div class="green-learn-more">
[[#Parameter Definition and Global Variables|
Parameter Definition and Global Variables: ]]
</div>Parameter creation and the use of global variables have been provided in the development environment.</li>
<li>
<div class="green-learn-more">
[[#Unit Management|Unit Management:]]
</div>
Unit creation processes are provided in the development environment.
</li>
<li>
<div class="green-learn-more">
[[#Customized Form|Customized Form:]]
</div>
Customized form operations are available in the Clomosy platform.
</li>
<li>
<div class="green-learn-more">
[[#Input Output|Input Output:]]
</div>
The platform includes the use of checkboxes.
</li>
<li>
<div class="green-learn-more">
[[#System Function|System Function:]]
</div>
The application infrastructure includes system functions such as platform information and dashboard operations.
</li>
<li><div class="green-learn-more">
[[#File and Stream Handling|File and Stream Handling:]]
</div>
The application includes file paths and file stream operations.</li>
<li><div class="green-learn-more">
[[#Notification & Messaging System|Notification & Messaging System:]]
</div>
The platform includes operations for sending notifications to users.</li>
<li><div class="green-learn-more">
[[#Database Connectivity|Database Connectivity:]]
</div>
The platform provides access to connection operations locally, in the cloud, on SQL servers, and in JSON format.</li>
</ul>
</div>
<br>
<br>


{| class="wikitable"
 
! Feature !! Use of !!Definition
<h2> Account Information  </h2>
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|-
| Firm_GUID: String; || Clomosy.Firm_GUID; || The GUID of the company where the user is located is provided. Educational accounts do not have a company GUID. For this reason, it returns "CLOSTARTER."
|function || Firm_GUID || The GUID of the company where the user is located is provided. Educational accounts do not have a company GUID. For this reason, it returns "CLOSTARTER."  
|-
|-
| Clomosy.Project_GUID: String; || Clomosy.Project_GUID; || The GUID of the project entered by the user is provided.
|function|| Project_GUID || The GUID of the project entered by the user is provided.  
|-
|function || AppProjectName || Returns the project name.
|}
</div>
For detailed information, visit [[Account_Information| page]].
<br>
<br>
<h2> User Account Information  </h2>
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|-
| Procedure RunUnit(AUnitName:String); || Clomosy.RunUnit('MyUnit1'); || When you want to invoke a simple unit in Clomosy, you can use the [[TclUnit | "RunUnit"]] property.
|function || AppUserGUID  || The user's GUID is retrieved.
|-
|-
|Function GetProjectUserDefParam(xParamName:String):TClJSonQuery; || Clomosy.GetProjectUserDefParam('harfCombo').FieldByName('Value_Integer').AsInteger; || You can get the values ​​of the variable created in the param template. Not available for free membership.
|function|| AppUserDisplayName || The username is taken.  
|-
|-
|Function RunOpenForm(OpenFormParams:TOpenFormParams):Integer; || Clomosy.RunOpenForm(Clomosy.OpenFormParams);|| It was created to enable the execution of the created custom form. [[Code_Example#Item_listing_using_RunOpenForm|Review example.]]
|function || AppUserProfile|| In the project, there is a check for whether the user is an administrator. If it's 1, they are an administrator; if it's 0, they are a regular user.
|-
|-
| Function OpenForm(FormName:TFormTemplate; OpenStyle:TFormDisplayType; Recording:TFormRecordOption; FilterOption:TFormFilterOption):Integer;||Clomosy.OpenForm(ftItems,fdtSingle,froAddNew,ffoNoFilter); ||Used to open custom form.
|procedure|| CallUserProfile || This is a feature for calling the profile page. In the structure you call, the profile page opens and comes from the side menu.
|}
</div>
For detailed information, visit [[User_Account_Information| page]].
<br>
<br>
<h2> Parameter Definition and Global Variables </h2>
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"|
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-|-
|rowspan="1"|Parameter Definition
|function ||[[GetProjectUserDefParam|GetProjectUserDefParam]]|| You can get the values ​​of the variable created in the param template. Not available for free membership.
|-|-
|rowspan="4"|Global Variables
|property|| [[Global_Variables#GlobalVariableString|GlobalVariableString]] || It holds the global string variable. You can call and use this variable in different units.
|-
|-
|Procedure AskAndCall(xAskStr:WideString; CallYesProc, CallNoProc:String); ||Clomosy.AskAndCall('Are You Cola','ProcYes','ProcNo'); ||It returns a check box. Operations can be made according to the yes or no option.
|property|| [[Global_Variables#GlobalVariableInteger|GlobalVariableInteger]] || It holds the global integer variable. You can call and use this variable in different units.
|-
|-
|Function Ask(AskStr:String):Boolean; ||Clomosy.Ask('Are You Cola?') ||It is the parameter required to write the question in the confirmation box.
|property|| [[Global_Variables#GlobalVariableDateTime|GlobalVariableDateTime]] || It is the function used to store data of the TclDateTime data type.
|-
|-
|Function ClomosyID:Integer; ||Clomosy.ClomosyID; ||If the return value is 0, it is known that you are in Clomosy CRM, and if it is 1, you are in the Clomosy Learn application.
|property|| [[Global_Variables#GlobalVariableStringList|GlobalVariableStringList]] || It is the function used to store and keep an array of the TclStringList data type.
|}
|}
</div>
<br>


= Send Message/Mail/Notify Feature =
<h2> Unit Management </h2>
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|function || [[RunUnit]]  || When you want to invoke a simple unit in Clomosy, you can use the "RunUnit" property.
|}
</div>
<br>


{| class="wikitable"
<h2> Customized Form </h2>
! Feature !! Use of !!Definition
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|-
|Function SendNotification(TitleStr, BodyStr, UserGUID :String):Boolean; ||Clomosy.SendNotification(notifTitleEdt.Text, notifTextEdt.Text, notifSendToEdt.Text); ||Used to send notifications to all users in the project.
|function || [[Clomosy_Base_Custom|RunOpenForm]] || It was created to enable the execution of the created custom form.
|-
|-
|Function SendNotifyAllUsers(TitleStr, BodyStr, WithoutUsers :String):Boolean; ||Clomosy.SendNotifyAllUsers(TitleEdt.Text, TextEdt.Text, SendToEdt.Text);||If there is a user in the project that is not wanted to be notified, by selecting that user, notifications are sent to others.
|function|| [[Clomosy_Base_Custom|OpenForm]] ||Used to open custom form.
|-
|-
|Function SendMailNoReplay(TitleStr, BodyStr, UserGUID :String):Boolean; ||Clomosy.SendMailNoReplay('Title:Information',ztStr,'[email protected]'); ||It is used to send a message to the desired e-mail address.
|function|| ResumeLocalEvent || It is used to prevent the next page from opening in ready-made template structures.
|}
|}
 
</div>
[[Clomosy_Scripts|Review example]].
For detailed information, visit [[Clomosy_Management_Panel#Params|page]].
 
<br>
= SQL Servers Feature =
<br>
 
<h2> Input Output </h2>
{| class="wikitable"
<div class="table-responsive">
! Feature !! Use of !!Definition
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|-
|Function DBSQLServerConnect(ProviderName, Server, UserName, UserPassword, Database:String; Port:Integer=1433):Boolean;||Clomosy.DBSQLServerConnect('SQL Server', Server, Kull, Sifre, DB, 1433);||It is a component used to connect Clomosy applications with SQL Server.
|procedure ||[[AskAndCall|AskAndCall]]|| It returns a check box. Operations can be made according to the yes or no option.
|-
|-
|Function DBSQLServerQueryWith(SQLStr:String):TUniQuery; ||Clomosy.DBSQLServerQueryWith('SELECT * FROM TBLSTOK'); ||Sql Server database query is made and data is accessed.
|function|| [[Ask|Ask]] || It is the parameter required to write the question in the confirmation box.
|}
|}
 
</div>
= Local Database Feature =
<br>
 
<h2> System Function </h2>
{| class="wikitable"
<div class="table-responsive">
! Feature !! Use of !!Definition
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|procedure|| [[LocationIsActive|LocationIsActive]] || n the project, it returns True if location information is enabled; otherwise, it returns False.
|-
|property || [[ShowExceptions]] || It is a mechanism used to display exceptions that occur in an application to the user.
|-
|procedure|| [[GetCurrentLocation|GetCurrentLocation]] ||In mobile applications, a function is used to obtain the current location of the device.
|-
|function|| [[AppPlatform|AppPlatform]] ||Depending on the platform the application is opened on, operations can be performed. 0: Windows, 1: MacOS, 2: iOS, 3: Android, 4: WinRT, 5: Linux
|-
|function || [[PlatformIsMobile|PlatformIsMobile]] ||If the platform on which the application is opened is mobile, it returns True, otherwise False.
|-
|function || [[PlatformIsTurkish|PlatformIsTurkish]] ||If the system language is Turkish, it returns True; otherwise, it returns False.
|-
|procedure || [[HoldScreen|HoldScreen]] ||The HoldScreen property determines whether the screen lock is on or off. When set to True, it prevents the screen from locking. Setting it to False enables screen locking. By default, it is set to False.
|-
|function|| [[ClomosyID|ClomosyID]] ||It is used to know which Clomosy applications you are using. If the return value is 0, it means that the project is entered through Clomosy CRM, and if it is 1, it means that the project is entered through Clomosy LEARN.
|-
|procedure|| [[ProcessMessages|ProcessMessages]] ||This function executes one cycle of an event processing loop and processes pending events.
|-
|procedure|| [[ClearTemporary|ClearTemporary]] ||The ClearTemporary feature is used to clean up temporary files of the projects used in the Clomosy Learn application, as well as the files created by the user on a project basis.
|-
|procedure|| [[Clipboard|SetClipBoard]] ||It is used to copy text or data to the clipboard.
|-
|-
|Function DBSQLiteConnect(Database, UPassword:String):Boolean;||Clomosy.DBSQLiteConnect(DB, Sifre); ||It is a component used to connect Clomosy applications with SQLite.
|procedure|| [[Clipboard|GetClipBoard]] ||It is used to retrieve text or data from the clipboard.  
|-
|-
|Function DBSQLiteQueryWith(SQLStr:String):TClSQLiteQuery;||Clomosy.DBSQLiteQueryWith('SELECT * FROM TBLSTOK'); ||Sqlite database query is made and data is accessed.
|procedure|| [[SleepAndCall|SleepAndCall]] || The sleepAndCall function represents a function that waits for a specific duration and then executes a specified callback function.
|}
|}
</div>
<br>


 
<h2> File and Stream Handling </h2>
= Cloud Database Feature =
<div class="table-responsive">
 
{| class="wikitable" style="border: 2px solid #c3d7e0"
{| class="wikitable"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
! Feature !! Use of !!Definition   
|-
|function || [[App_Path#AppBasePath|AppBasePath]] || It is a property representing the path to the main directory where an application is launched.
|-
|function|| [[App_Path#AppFilesPath|AppFilesPath]] || It is a property that represents the file path of the application.
|-
|function|| [[TclStringList|StringListNew]] || It is the process of creating a useful class that provides a list-like structure to store and manage an array of arrays.
|-
|function|| [[TclStringList|StringListItemString]] || The StringListItemString(ListVariable,index) property of the Clomosy library is used to provide access to the items in the list.
|-
|function|| [[StreamToBase64|StreamToBase64]] ||It is a function used to convert a data stream (TCLMemoryStream) to Base64 format.
|-
|function||[[FileToStream|FileToStream]]||It is the process of reading the content of a file and transferring this content into a TclMemoryStream derivative in memory.
|-
|function|| [[FileToBase64|FileToBase64]] ||It is a function used to convert the content of a file to Base64 format.
|-
|-
|Function DBCloudSQLSelectWith(SQLStr:String):TClJSonQuery;||Clomosy.DBCloudSQLSelectWith(sqlString); ||It can be used to retrieve data from a specific database table or view or to execute an SQL query.
|function|| [[Base64ToFile|Base64ToFile]]  ||It is a function used to convert a Base64 string to a file.
|-
|-
|Function DBCloudQueryWith(CloudDataSource:TFormTemplate;Filter_GUID, FilterStr:String):TClJSonQuery;||Clomosy.DBCloudQueryWith(ftProducts,'','1=1'); ||Cloud database query is made and data is accessed.
|function|| [[Base64ToStream|Base64ToStream]] ||It is a function used to convert a Base64 string to a stream (TCLMemoryStream).
|-
|-
|Function DBCloudPostJSON(CloudDataSource:TFormTemplate; DataJSON:String):Boolean; ||Clomosy.DBCloudPostJSON(ftThreads,'[{"Thread_Value_Str":"Test Exam"}]'); ||It is a process used to handle JSON data from a database.
|function|| [[CLParseJSON|CLParseJSON]] || CLParseJSON function is used to process data in JSON format. This function parses the JSON data according to a specified structure and retrieves the specified field (path).  
|}
|}
</div>
<br>


= Data Source Process =
<h2> Cryptographic Encryption </h2>


{| class="wikitable"
<div class="table-responsive">
! Feature !! Use of !!Definition
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name  !!style="background-color: #c3d7e0"| Definition
|-
|-
|function ClDataSetFromJSON(payload : String):TClJSonQuery;||Clomosy.ClDataSetFromJSON('[{"name":"Jack","age":22}]');||It can represent the process of converting data that comes in JSON format into a dataset.
|function ||[[AES Encryption]] || It is an encryption algorithm used to encrypt data and decrypt encrypted data.
|}
|}
</div>


= Image Procedure and Functions Feature=
 
{| class="wikitable"
<h2> Notification & Messaging System </h2>
! Feature !! Use of !!Definition
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"| Definition
|-
|-
|Procedure GlobalBitmapSaveToFile(aFileName:String);||Clomosy.GlobalBitmapSaveToFile('x:\GlobalBitmap.png');||It allows converting an image or bitmap into a file and saving it to a desired directory.
|function || [[Notification| SendNotification]] || Used to send notifications to all users in the project.
|-
|function|| [[Notification|SendNotifyAllUsers]] || If there is a user in the project that is not wanted to be notified, by selecting that user, notifications are sent to others.
|-
|function|| [[Send Email|SendMailNoReplay]] || It is used to send a message to the desired e-mail address.
|}
|}
</div>


= System Feature =
<h2> Database Connectivity </h2>
{| class="wikitable"
 
! Feature !! Use of !!Definition
<div class="table-responsive">
{| class="wikitable" style="border: 2px solid #c3d7e0"
! style="background-color: #c3d7e0"|
! style="background-color: #c3d7e0"| Type !!style="background-color: #c3d7e0"| Name !!style="background-color: #c3d7e0"|Definition
|-
|rowspan="2"|[[SQL_Server_Queries|SQL Server]]
|function
|DBSQLServerConnect
|It is a component used to connect Clomosy applications with SQL Server.
|-
|function
|DBSQLServerQueryWith
|Sql Server database query is made and data is accessed.
|-
|rowspan="2"|[[Local_Database_Queries|Local Database]]
|function
|DBSQLiteConnect
|It is a component used to connect Clomosy applications with SQLite.
|-
|function
|DBSQLiteQueryWith
|Sqlite database query is made and data is accessed.
|-
|rowspan="3"|[[Clomosy_Cloud_Database_Technology | Cloud Database]]
|function
|DBCloudSQLSelectWith
|It can be used to retrieve data from a specific database table or view or to execute an SQL query.
|-
|function
|DBSQLServerQueryWith
|Cloud database query is made and data is accessed.
|-
|function
|DBCloudPostJSON
|It is a process used to handle JSON data from a database.
|-
|-
|Procedure ProcessMessages;||Clomosy.GlobalBitmapSaveToFile('x:\GlobalBitmap.png');||It allows converting an image or bitmap into a file and saving it to a desired directory.
|rowspan="1"|[[JSON Data Source|JSON Data Source]]
|function
|ClDataSetFromJSON
|It can represent the process of converting data that comes in JSON format into a dataset.
|}
|}
</div>
{{#seo:|description=A guide to using Clomosy's class structure for efficient mobile app development and organization.}}

Latest revision as of 12:21, 16 April 2025

In Clomosy programming, classes are the fundamental building blocks of object-oriented programming. A class is a structure that encompasses data and behaviors, forming the basis for creating objects. Clomosy's class-based structure enhances the organization, clarity, and manageability of code.

The properties of the Clomosy class gather data and behaviors together, enabling the design of complex projects in a more comprehensible manner.




Account Information

Type Name Definition
function Firm_GUID The GUID of the company where the user is located is provided. Educational accounts do not have a company GUID. For this reason, it returns "CLOSTARTER."
function Project_GUID The GUID of the project entered by the user is provided.
function AppProjectName Returns the project name.

For detailed information, visit page.

User Account Information

Type Name Definition
function AppUserGUID The user's GUID is retrieved.
function AppUserDisplayName The username is taken.
function AppUserProfile In the project, there is a check for whether the user is an administrator. If it's 1, they are an administrator; if it's 0, they are a regular user.
procedure CallUserProfile This is a feature for calling the profile page. In the structure you call, the profile page opens and comes from the side menu.

For detailed information, visit page.

Parameter Definition and Global Variables

Type Name Definition
Parameter Definition function GetProjectUserDefParam You can get the values ​​of the variable created in the param template. Not available for free membership.
Global Variables property GlobalVariableString It holds the global string variable. You can call and use this variable in different units.
property GlobalVariableInteger It holds the global integer variable. You can call and use this variable in different units.
property GlobalVariableDateTime It is the function used to store data of the TclDateTime data type.
property GlobalVariableStringList It is the function used to store and keep an array of the TclStringList data type.


Unit Management

Type Name Definition
function RunUnit When you want to invoke a simple unit in Clomosy, you can use the "RunUnit" property.


Customized Form

Type Name Definition
function RunOpenForm It was created to enable the execution of the created custom form.
function OpenForm Used to open custom form.
function ResumeLocalEvent It is used to prevent the next page from opening in ready-made template structures.

For detailed information, visit page.

Input Output

Type Name Definition
procedure AskAndCall It returns a check box. Operations can be made according to the yes or no option.
function Ask It is the parameter required to write the question in the confirmation box.


System Function

Type Name Definition
procedure LocationIsActive n the project, it returns True if location information is enabled; otherwise, it returns False.
property ShowExceptions It is a mechanism used to display exceptions that occur in an application to the user.
procedure GetCurrentLocation In mobile applications, a function is used to obtain the current location of the device.
function AppPlatform Depending on the platform the application is opened on, operations can be performed. 0: Windows, 1: MacOS, 2: iOS, 3: Android, 4: WinRT, 5: Linux
function PlatformIsMobile If the platform on which the application is opened is mobile, it returns True, otherwise False.
function PlatformIsTurkish If the system language is Turkish, it returns True; otherwise, it returns False.
procedure HoldScreen The HoldScreen property determines whether the screen lock is on or off. When set to True, it prevents the screen from locking. Setting it to False enables screen locking. By default, it is set to False.
function ClomosyID It is used to know which Clomosy applications you are using. If the return value is 0, it means that the project is entered through Clomosy CRM, and if it is 1, it means that the project is entered through Clomosy LEARN.
procedure ProcessMessages This function executes one cycle of an event processing loop and processes pending events.
procedure ClearTemporary The ClearTemporary feature is used to clean up temporary files of the projects used in the Clomosy Learn application, as well as the files created by the user on a project basis.
procedure SetClipBoard It is used to copy text or data to the clipboard.
procedure GetClipBoard It is used to retrieve text or data from the clipboard.
procedure SleepAndCall The sleepAndCall function represents a function that waits for a specific duration and then executes a specified callback function.


File and Stream Handling

Type Name Definition
function AppBasePath It is a property representing the path to the main directory where an application is launched.
function AppFilesPath It is a property that represents the file path of the application.
function StringListNew It is the process of creating a useful class that provides a list-like structure to store and manage an array of arrays.
function StringListItemString The StringListItemString(ListVariable,index) property of the Clomosy library is used to provide access to the items in the list.
function StreamToBase64 It is a function used to convert a data stream (TCLMemoryStream) to Base64 format.
function FileToStream It is the process of reading the content of a file and transferring this content into a TclMemoryStream derivative in memory.
function FileToBase64 It is a function used to convert the content of a file to Base64 format.
function Base64ToFile It is a function used to convert a Base64 string to a file.
function Base64ToStream It is a function used to convert a Base64 string to a stream (TCLMemoryStream).
function CLParseJSON CLParseJSON function is used to process data in JSON format. This function parses the JSON data according to a specified structure and retrieves the specified field (path).


Cryptographic Encryption

Type Name Definition
function AES Encryption It is an encryption algorithm used to encrypt data and decrypt encrypted data.


Notification & Messaging System

Type Name Definition
function SendNotification Used to send notifications to all users in the project.
function SendNotifyAllUsers If there is a user in the project that is not wanted to be notified, by selecting that user, notifications are sent to others.
function SendMailNoReplay It is used to send a message to the desired e-mail address.

Database Connectivity

Type Name Definition
SQL Server function DBSQLServerConnect It is a component used to connect Clomosy applications with SQL Server.
function DBSQLServerQueryWith Sql Server database query is made and data is accessed.
Local Database function DBSQLiteConnect It is a component used to connect Clomosy applications with SQLite.
function DBSQLiteQueryWith Sqlite database query is made and data is accessed.
Cloud Database function DBCloudSQLSelectWith It can be used to retrieve data from a specific database table or view or to execute an SQL query.
function DBSQLServerQueryWith Cloud database query is made and data is accessed.
function DBCloudPostJSON It is a process used to handle JSON data from a database.
JSON Data Source function ClDataSetFromJSON It can represent the process of converting data that comes in JSON format into a dataset.
Retrieved from "http:///index.php?title=Clomosy_Class&oldid=3949"