From Clomosy Docs
ClomosyAdmin (talk | contribs) No edit summary |
ClomosyAdmin (talk | contribs) No edit summary |
||
| Line 33: | Line 33: | ||
</div> | </div> | ||
<br> | <br> | ||
== Parameter Definition == | == Parameter Definition and Global Variables == | ||
<div class="table-responsive"> | <div class="table-responsive"> | ||
{| class="wikitable" style="border: 2px solid #c3d7e0" | {| class="wikitable" style="border: 2px solid #c3d7e0" | ||
Revision as of 07:51, 14 October 2024
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 Using |
|---|---|---|
| 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 Using |
|---|---|---|
| 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. |
Parameter Definition and Global Variables
| Type | Name | Definition Using |
|---|---|---|
| function | GetProjectUserDefParam | You can get the values of the variable created in the param template. Not available for free membership. |
| function | GlobalVariableString | It holds the global string variable. You can call and use this variable in different units. |
| function | GlobalVariableInteger | It holds the global integer variable. You can call and use this variable in different units. |
| function | GlobalBitmapSaveToFile | It allows converting an image or bitmap into a file and saving it to a desired directory. |
Unit Management
| Type | Name | Definition Using |
|---|---|---|
| function | RunUnit | When you want to invoke a simple unit in Clomosy, you can use the "RunUnit" property. |
Customized Form
| Type | Name | Definition Using |
|---|---|---|
| function | RunOpenForm | It was created to enable the execution of the created custom form.Review example. |
| function | OpenForm | Used to open custom form. |
| function | ResumeLocalEvent | It is used to prevent the next page from opening in ready-made template structures. |
Input Output
| Type | Name | Definition Using |
|---|---|---|
| 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. |
Unit Management
| Type | Name | Definition Using |
|---|---|---|
| function | RunUnit | When you want to invoke a simple unit in Clomosy, you can use the "RunUnit" property. |
System Function
| Type | Name | Definition Using |
|---|---|---|
| procedure | LocationIsActive | In projects with templates, if location information is on, it returns 1, otherwise it returns 0. |
| 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. |
| procedure | PlatformIsTurkish | If the system language is Turkish, it returns True; otherwise, it returns False. |
| function | 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. |
File and Stream Handling
| Type | Name | Definition Using |
|---|---|---|
| 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.Review example. |
| 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). |
Notification & Messaging System
| Type | Name | Definition Using |
|---|---|---|
| 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 Using | |
|---|---|---|---|
| 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. | |
| Data Source | function | ClDataSetFromJSON | It can represent the process of converting data that comes in JSON format into a dataset. |