Skip to content

Commit dbdd30d

Browse files
eyupyuseineyupyusein
authored
chore: add readme files to all samples (#539)
1 parent 718cbff commit dbdd30d

File tree

140 files changed

+7330
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+7330
-0
lines changed

‎Telerik.Examples.Mvc/Telerik.Examples.Mvc/Areas/Bundles/README.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## Sample Overview
2+
This area demonstrates how to configure ASP.NET MVC bundling and minification for Telerik UI resources in an ASP.NET MVC application. The sample shows how to register and use script and style bundles for Telerik components to optimize page load performance by combining and compressing CSS and JavaScript files.
3+
4+
Common techniques shown in this sample:
5+
- Registering Telerik JavaScript bundles including kendo.all.min.js and kendo.aspnetmvc.min.js
6+
- Registering Telerik CSS theme bundles
7+
- Using @Scripts.Render() and @Styles.Render() helpers to include bundled resources
8+
- Configuring bundle optimization settings
9+
- Clearing and customizing the bundle ignore list
10+
11+
---
12+
13+
UI for ASP.NET MVC Examples
14+
==========================
15+
16+
This repo contains a collection of Telerik UI for ASP.NET MVC examples. They are located in the Area folder of the project for convenience to the user. The provided samples:
17+
18+
- Demonstrate frequently asked questions, features, and scenarios.
19+
- Are not part of our testing procedures and should be regarded as a knowledge base.
20+
- Might contain custom implementations which can be changed or integrated built-in with future release versions of the Product.
21+
22+
**DISCLAIMER: The Telerik.Examples.Mvc project is created only for demonstration purpose of the code samples and syntax. Its references, external packages and current versions should not be used in production and we don't claim responsibility for any package security.**
23+
24+
To run projects from this repository:
25+
26+
1. Clone the repo.
27+
2. Open the Telerik.Examples.Mvc.sln file in Visual Studio.
28+
3. Clean the solution.
29+
4. Restore any missing NuGet packages.
30+
5. Build the solution and run the project.
31+
32+
## Adding New Examples
33+
34+
To add a new sample, you can
35+
36+
1. Create a new Area which will contain all the necessary files. The Naming of the sample should follow this logic:
37+
38+
![naming](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/naming.png)
39+
40+
2. Delete the web.config file and Views/Shared folder as they are optional.
41+
3. Alternatively, you can copy another working Area and do mass-renaming.
42+
4. It is important to apply namespaces to the Controllers and Models of the example so the classes do not become ambiguous, e.g. Telerik.Examples.Mvc.Areas.GridSelectionByField.Models
43+
5. If you are adding an example with database, ensure that you change the EF model class names, but not the collection names:
44+
45+
![model-browser](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/model-browser.png)
46+
47+
And then you can add new Entity definition to the Web.config like this:
48+
49+
```
50+
<add name="GridEditingInLineDatabaseEntities" connectionString="metadata=res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.csdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.ssdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.msl;provider=System.Data.SqlClient;provider connection string='Data Source=(LocalDB)\MSSQLLocalDB;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;connect timeout=30;MultipleActiveResultSets=True;App=EntityFramework'" providerName="System.Data.EntityClient" />
51+
```
52+
53+
54+

‎Telerik.Examples.Mvc/Telerik.Examples.Mvc/Areas/Captcha/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Sample Overview
2+
This area demonstrates how to implement CAPTCHA validation using the Telerik Captcha component in ASP.NET MVC. The sample shows image and audio CAPTCHA generation, server-side validation, and AJAX-based refresh functionality to prevent automated form submissions.
3+
4+
Common techniques shown in this sample:
5+
- Generating CAPTCHA images and audio files using Telerik.Web.Captcha helper
6+
- Storing CAPTCHA text in server-side session
7+
- Implementing server-side validation of user input against CAPTCHA text
8+
- Handling AJAX-based CAPTCHA reset and validation events
9+
- Rendering CAPTCHA with image and audio accessibility options
10+
11+
---
12+
13+
UI for ASP.NET MVC Examples
14+
==========================
15+
16+
This repo contains a collection of Telerik UI for ASP.NET MVC examples. They are located in the Area folder of the project for convenience to the user. The provided samples:
17+
18+
- Demonstrate frequently asked questions, features, and scenarios.
19+
- Are not part of our testing procedures and should be regarded as a knowledge base.
20+
- Might contain custom implementations which can be changed or integrated built-in with future release versions of the Product.
21+
22+
**DISCLAIMER: The Telerik.Examples.Mvc project is created only for demonstration purpose of the code samples and syntax. Its references, external packages and current versions should not be used in production and we don't claim responsibility for any package security.**
23+
24+
To run projects from this repository:
25+
26+
1. Clone the repo.
27+
2. Open the Telerik.Examples.Mvc.sln file in Visual Studio.
28+
3. Clean the solution.
29+
4. Restore any missing NuGet packages.
30+
5. Build the solution and run the project.
31+
32+
## Adding New Examples
33+
34+
To add a new sample, you can
35+
36+
1. Create a new Area which will contain all the necessary files. The Naming of the sample should follow this logic:
37+
38+
![naming](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/naming.png)
39+
40+
2. Delete the web.config file and Views/Shared folder as they are optional.
41+
3. Alternatively, you can copy another working Area and do mass-renaming.
42+
4. It is important to apply namespaces to the Controllers and Models of the example so the classes do not become ambiguous, e.g. Telerik.Examples.Mvc.Areas.GridSelectionByField.Models
43+
5. If you are adding an example with database, ensure that you change the EF model class names, but not the collection names:
44+
45+
![model-browser](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/model-browser.png)
46+
47+
And then you can add new Entity definition to the Web.config like this:
48+
49+
```
50+
<add name="GridEditingInLineDatabaseEntities" connectionString="metadata=res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.csdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.ssdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.msl;provider=System.Data.SqlClient;provider connection string='Data Source=(LocalDB)\MSSQLLocalDB;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;connect timeout=30;MultipleActiveResultSets=True;App=EntityFramework'" providerName="System.Data.EntityClient" />
51+
```

‎Telerik.Examples.Mvc/Telerik.Examples.Mvc/Areas/CdnFallback/README.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## Sample Overview
2+
This area demonstrates how to implement CDN fallback for static resources (scripts and styles) in an ASP.NET MVC application using Telerik assets. The sample shows how to configure the application to first load resources from a CDN and automatically fall back to local copies if the CDN is unavailable.
3+
4+
Common techniques shown in this sample:
5+
- Configuring CDN URLs for Telerik scripts and stylesheets
6+
- Implementing fallback logic to detect CDN failures
7+
- Using conditional script loading based on object detection (e.g., checking for window.kendo)
8+
- Providing local file copies as backup resources
9+
- Ensuring application reliability when external CDN services are down
10+
11+
---
12+
13+
UI for ASP.NET MVC Examples
14+
==========================
15+
16+
This repo contains a collection of Telerik UI for ASP.NET MVC examples. They are located in the Area folder of the project for convenience to the user. The provided samples:
17+
18+
- Demonstrate frequently asked questions, features, and scenarios.
19+
- Are not part of our testing procedures and should be regarded as a knowledge base.
20+
- Might contain custom implementations which can be changed or integrated built-in with future release versions of the Product.
21+
22+
**DISCLAIMER: The Telerik.Examples.Mvc project is created only for demonstration purpose of the code samples and syntax. Its references, external packages and current versions should not be used in production and we don't claim responsibility for any package security.**
23+
24+
To run projects from this repository:
25+
26+
1. Clone the repo.
27+
2. Open the Telerik.Examples.Mvc.sln file in Visual Studio.
28+
3. Clean the solution.
29+
4. Restore any missing NuGet packages.
30+
5. Build the solution and run the project.
31+
32+
## Adding New Examples
33+
34+
To add a new sample, you can
35+
36+
1. Create a new Area which will contain all the necessary files. The Naming of the sample should follow this logic:
37+
38+
![naming](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/naming.png)
39+
40+
2. Delete the web.config file and Views/Shared folder as they are optional.
41+
3. Alternatively, you can copy another working Area and do mass-renaming.
42+
4. It is important to apply namespaces to the Controllers and Models of the example so the classes do not become ambiguous, e.g. Telerik.Examples.Mvc.Areas.GridSelectionByField.Models
43+
5. If you are adding an example with database, ensure that you change the EF model class names, but not the collection names:
44+
45+
![model-browser](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/model-browser.png)
46+
47+
And then you can add new Entity definition to the Web.config like this:
48+
49+
```
50+
<add name="GridEditingInLineDatabaseEntities" connectionString="metadata=res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.csdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.ssdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.msl;provider=System.Data.SqlClient;provider connection string='Data Source=(LocalDB)\MSSQLLocalDB;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;connect timeout=30;MultipleActiveResultSets=True;App=EntityFramework'" providerName="System.Data.EntityClient" />
51+
```
52+
53+
54+

‎Telerik.Examples.Mvc/Telerik.Examples.Mvc/Areas/ChartDynamicSeries/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Sample Overview
2+
This area demonstrates how to dynamically generate and bind multiple series to a Telerik Chart component in ASP.NET MVC. The sample shows how to create Chart visualizations with dynamically determined number of series and categories, useful for scenarios where the data structure is not known at compile time.
3+
4+
Common techniques shown in this sample:
5+
- Creating view models that hold series data collections
6+
- Dynamically generating chart series based on data
7+
- Configuring column or bar series with multiple data sets
8+
- Binding chart to controller-generated dynamic data
9+
- Rendering multiple series with different configurations
10+
11+
---
12+
13+
UI for ASP.NET MVC Examples
14+
==========================
15+
16+
This repo contains a collection of Telerik UI for ASP.NET MVC examples. They are located in the Area folder of the project for convenience to the user. The provided samples:
17+
18+
- Demonstrate frequently asked questions, features, and scenarios.
19+
- Are not part of our testing procedures and should be regarded as a knowledge base.
20+
- Might contain custom implementations which can be changed or integrated built-in with future release versions of the Product.
21+
22+
**DISCLAIMER: The Telerik.Examples.Mvc project is created only for demonstration purpose of the code samples and syntax. Its references, external packages and current versions should not be used in production and we don't claim responsibility for any package security.**
23+
24+
To run projects from this repository:
25+
26+
1. Clone the repo.
27+
2. Open the Telerik.Examples.Mvc.sln file in Visual Studio.
28+
3. Clean the solution.
29+
4. Restore any missing NuGet packages.
30+
5. Build the solution and run the project.
31+
32+
## Adding New Examples
33+
34+
To add a new sample, you can
35+
36+
1. Create a new Area which will contain all the necessary files. The Naming of the sample should follow this logic:
37+
38+
![naming](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/naming.png)
39+
40+
2. Delete the web.config file and Views/Shared folder as they are optional.
41+
3. Alternatively, you can copy another working Area and do mass-renaming.
42+
4. It is important to apply namespaces to the Controllers and Models of the example so the classes do not become ambiguous, e.g. Telerik.Examples.Mvc.Areas.GridSelectionByField.Models
43+
5. If you are adding an example with database, ensure that you change the EF model class names, but not the collection names:
44+
45+
![model-browser](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/model-browser.png)
46+
47+
And then you can add new Entity definition to the Web.config like this:
48+
49+
```
50+
<add name="GridEditingInLineDatabaseEntities" connectionString="metadata=res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.csdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.ssdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.msl;provider=System.Data.SqlClient;provider connection string='Data Source=(LocalDB)\MSSQLLocalDB;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;connect timeout=30;MultipleActiveResultSets=True;App=EntityFramework'" providerName="System.Data.EntityClient" />
51+
```

‎Telerik.Examples.Mvc/Telerik.Examples.Mvc/Areas/ChartInGrid/README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Sample Overview
2+
This area demonstrates how to embed Telerik Chart components inside Grid rows using client templates in ASP.NET MVC. The sample shows two approaches: charts that load data remotely via AJAX and charts that use data from the Grid's own data source, enabling powerful data visualization within tabular layouts.
3+
4+
Common techniques shown in this sample:
5+
- Using Grid ClientTemplate to render Chart components in rows
6+
- Implementing remote data binding for charts via AJAX Read actions
7+
- Binding charts to local data from Grid row data items
8+
- Converting server-side Chart declarations to client templates using ToClientTemplate()
9+
- Handling chart initialization and data binding in Grid's DataBound event
10+
- Destroying and reinitializing components on Grid data operations
11+
12+
---
13+
14+
UI for ASP.NET MVC Examples
15+
==========================
16+
17+
This repo contains a collection of Telerik UI for ASP.NET MVC examples. They are located in the Area folder of the project for convenience to the user. The provided samples:
18+
19+
- Demonstrate frequently asked questions, features, and scenarios.
20+
- Are not part of our testing procedures and should be regarded as a knowledge base.
21+
- Might contain custom implementations which can be changed or integrated built-in with future release versions of the Product.
22+
23+
**DISCLAIMER: The Telerik.Examples.Mvc project is created only for demonstration purpose of the code samples and syntax. Its references, external packages and current versions should not be used in production and we don't claim responsibility for any package security.**
24+
25+
To run projects from this repository:
26+
27+
1. Clone the repo.
28+
2. Open the Telerik.Examples.Mvc.sln file in Visual Studio.
29+
3. Clean the solution.
30+
4. Restore any missing NuGet packages.
31+
5. Build the solution and run the project.
32+
33+
## Adding New Examples
34+
35+
To add a new sample, you can
36+
37+
1. Create a new Area which will contain all the necessary files. The Naming of the sample should follow this logic:
38+
39+
![naming](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/naming.png)
40+
41+
2. Delete the web.config file and Views/Shared folder as they are optional.
42+
3. Alternatively, you can copy another working Area and do mass-renaming.
43+
4. It is important to apply namespaces to the Controllers and Models of the example so the classes do not become ambiguous, e.g. Telerik.Examples.Mvc.Areas.GridSelectionByField.Models
44+
5. If you are adding an example with database, ensure that you change the EF model class names, but not the collection names:
45+
46+
![model-browser](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/model-browser.png)
47+
48+
And then you can add new Entity definition to the Web.config like this:
49+
50+
```
51+
<add name="GridEditingInLineDatabaseEntities" connectionString="metadata=res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.csdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.ssdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.msl;provider=System.Data.SqlClient;provider connection string='Data Source=(LocalDB)\MSSQLLocalDB;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;connect timeout=30;MultipleActiveResultSets=True;App=EntityFramework'" providerName="System.Data.EntityClient" />
52+
```

‎Telerik.Examples.Mvc/Telerik.Examples.Mvc/Areas/ChartSignalR/README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Sample Overview
2+
This area demonstrates real-time chart updates using SignalR in ASP.NET MVC. The sample shows how to connect a Telerik Chart component to a SignalR hub for live data push notifications, enabling the chart to automatically update when data changes on the server without requiring page refreshes.
3+
4+
Common techniques shown in this sample:
5+
- Configuring Telerik Chart with SignalR data source transport
6+
- Connecting to remote SignalR hubs using HubConnectionBuilder
7+
- Implementing client-side hub methods for real-time data synchronization
8+
- Handling push notifications for Create, Update, and Destroy operations
9+
- Using Promise-based hub connection with automatic reconnection
10+
- Displaying real-time notifications when data changes occur
11+
12+
---
13+
14+
UI for ASP.NET MVC Examples
15+
==========================
16+
17+
This repo contains a collection of Telerik UI for ASP.NET MVC examples. They are located in the Area folder of the project for convenience to the user. The provided samples:
18+
19+
- Demonstrate frequently asked questions, features, and scenarios.
20+
- Are not part of our testing procedures and should be regarded as a knowledge base.
21+
- Might contain custom implementations which can be changed or integrated built-in with future release versions of the Product.
22+
23+
**DISCLAIMER: The Telerik.Examples.Mvc project is created only for demonstration purpose of the code samples and syntax. Its references, external packages and current versions should not be used in production and we don't claim responsibility for any package security.**
24+
25+
To run projects from this repository:
26+
27+
1. Clone the repo.
28+
2. Open the Telerik.Examples.Mvc.sln file in Visual Studio.
29+
3. Clean the solution.
30+
4. Restore any missing NuGet packages.
31+
5. Build the solution and run the project.
32+
33+
## Adding New Examples
34+
35+
To add a new sample, you can
36+
37+
1. Create a new Area which will contain all the necessary files. The Naming of the sample should follow this logic:
38+
39+
![naming](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/naming.png)
40+
41+
2. Delete the web.config file and Views/Shared folder as they are optional.
42+
3. Alternatively, you can copy another working Area and do mass-renaming.
43+
4. It is important to apply namespaces to the Controllers and Models of the example so the classes do not become ambiguous, e.g. Telerik.Examples.Mvc.Areas.GridSelectionByField.Models
44+
5. If you are adding an example with database, ensure that you change the EF model class names, but not the collection names:
45+
46+
![model-browser](../../../../Telerik.Examples.Mvc/Telerik.Examples.Mvc/Images/readme-images/model-browser.png)
47+
48+
And then you can add new Entity definition to the Web.config like this:
49+
50+
```
51+
<add name="GridEditingInLineDatabaseEntities" connectionString="metadata=res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.csdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.ssdl|res://*/Areas.GridEditingInLineDatabase.Models.SampleModel.msl;provider=System.Data.SqlClient;provider connection string='Data Source=(LocalDB)\MSSQLLocalDB;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;connect timeout=30;MultipleActiveResultSets=True;App=EntityFramework'" providerName="System.Data.EntityClient" />
52+
```

0 commit comments

Comments
 (0)