Skip to content

Commit 551ad58

Browse files
committed
updated docs and class
1 parent 4cba984 commit 551ad58

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Custom [Classes](https://github.com/redmalmon/csharp-custom-classes/tree/main/Cl
77

88
## [Classes](https://github.com/redmalmon/csharp-custom-classes/tree/main/Classes)
99

10-
### How to use?
10+
## How to use?
1111
1. Copy the [Classes](https://github.com/redmalmon/csharp-custom-classes/tree/main/Classes) folder into your project folder.
1212
2. From your project folder root directory, create a class named " [Config](https://github.com/redmalmon/csharp-custom-classes/blob/main/Config.cs) " and create a public instance of all the classes from [Classes](https://github.com/redmalmon/csharp-custom-classes/tree/main/Classes) folder. See the code below:
1313
```c#
@@ -69,7 +69,7 @@ Custom [Classes](https://github.com/redmalmon/csharp-custom-classes/tree/main/Cl
6969
```
7070

7171

72-
### Using [Database](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Database.cs) class - this is use for MySqlClient configurations, sql statements, & etc. This will also included the loading of data to a form control including dataGridView and comboBox.
72+
## 1. Using [Database](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Database.cs) class - this is use for MySqlClient configurations, sql statements, & etc. This will also included the loading of data to a form control including dataGridView and comboBox.
7373
7474
#### Using Database' Methods
7575

@@ -149,7 +149,8 @@ int id = config.db.maxid('userid', 'users'); // it will return an int value
149149

150150

151151

152-
### Using [Form_UI](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Form_UI.cs) class
152+
153+
## 2. Using [Form_UI](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Form_UI.cs) class -
153154

154155
This class includes the traditional way of displaying form. Also includes the advanced UI manipulation using MDI or Multiple Document Interface.
155156

@@ -188,7 +189,8 @@ config.ui.FormShow(dash); // or config.ui.FormShow(new frmDashboard());
188189
```
189190

190191

191-
### Using [Visualizer](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Visualizer.cs) - use for visualization of data.
192+
193+
## 3. Using [Visualizer](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Visualizer.cs) class - use for visualization of data.
192194

193195
* `chart(Chart chart, string SeriesName, string[] x, int[] y, string chartType = "Column")` or chart() method
194196

@@ -272,7 +274,8 @@ config.visualizer.chart(chartUser, "FEMALE", x2, y2, "Bar");
272274
```
273275

274276

275-
### Using [Validations](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Validation.cs) class - use for validationg inputs (keyboard events, mouse events, etc.)
277+
278+
## 4. Using [Validations](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Validation.cs) class - use for validationg inputs (keyboard events, mouse events, etc.)
276279
277280

278281
* The `txtRequired(TextBox[] txt, bool allow_message = false, string msg = "Please fillup required fields!")` or txtRequired() method use to validate required textbox controls. There is also validation for comboBox controls, the `cmbRequired(ComboBox[] cmb, bool allow_message = false, string msg = "Please select required fields!")` method. These functions return `false` if ther is an empty value in the fields.
@@ -294,10 +297,13 @@ private void txtUsername_KeyPress(object sender, KeyPressEventArgs e)
294297
```
295298

296299

297-
### 2. [Date_time](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Str_Date_Time.cs) class - for date & time format conversion
300+
301+
## 5. Using [Date_time](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Str_Date_Time.cs) class - for date & time format conversion
298302
299303
*
300304

301-
### Using [Upload](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Upload.cs) class - working with files & directories
302305

303-
*
306+
## 6. Using [Upload](https://github.com/redmalmon/csharp-custom-classes/blob/main/Classes/Upload.cs) class - working with files & directories
307+
308+
*
309+

0 commit comments

Comments
 (0)