Skip to content

Commit 902619c

Browse files
ArtemProsvirninArtemProsvirnin
committed
Readme.md
1 parent 2162993 commit 902619c

File tree

2 files changed

+163
-1
lines changed

2 files changed

+163
-1
lines changed

‎.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
.vs
22
packages/*
33
*/bin/*
4-
*/obj/*
4+
*/obj/*
5+
*_distrib.csproj
6+
*.csproj.user

‎README.md

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# C# Demo Projects for [Active Query Builder ASP.NET Edition](http://www.activequerybuilder.com/product_asp.html)
2+
3+
##### Also, check [the VB.NET Demo projects repository](https://github.com/ActiveDbSoft/active-query-builder-2-asp-net-samples-vb) for the same.
4+
#
5+
## What is Active Query Builder?
6+
Active Query Builder is a visual query builder and SQL parser component for ASP.NET (WebForms, MVC and Core 2.0).
7+
##### Details:
8+
- [Active Query Builder website](http://www.activequerybuilder.com/),
9+
- [Active Query Builder ASP.NET Edition details page](http://www.activequerybuilder.com/product_asp.html).
10+
11+
## How do I get Active Query Builder?
12+
- [Download the trial version](http://www.activequerybuilder.com/trequest.html?request=asp) from the product web site
13+
- Get it by installing the [ActiveQueryBuilder.ASPNET NuGet package](https://www.nuget.org/packages/ActiveQueryBuilder.ASPNET/).
14+
15+
## What's in this repository?
16+
The demo projects in this repository illustrate various aspects of the component's functionality from basic usage scenarios to advanced features. They are also included the trial and full versions of Active Query Builder.
17+
A brief description of each project can be found below.
18+
##### Prerequisites:
19+
- Visual Studio 2012 or higher,
20+
- .NET Framework 4.0 or higher.
21+
- [Active Query Builder ASP.NET NuGet package](https://www.nuget.org/packages/ActiveQueryBuilder.ASPNET/).
22+
23+
## How to get these demo projects up and running?
24+
25+
1. Clone this repository to your PC.
26+
2. Open the "Samples.sln" solution to review the WebForms or MVC demos or the "AspNetCoreSamples.sln" to review the Core over .NET Framework sample projects.
27+
3. Select the "Tools" - "NuGet Package Manager" - "**Package Manager Console**" menu item.
28+
4. Install **Active Query Builder ASP.NET NuGet package** by running the following command:
29+
```Install-Package ActiveQueryBuilder.ASPNET```
30+
5. Run the project.
31+
32+
## Have a question or want to leave feedback?
33+
34+
Welcome to the [Active Query Builder Help Center](https://support.activequerybuilder.com/hc/)!
35+
There you will find:
36+
- End-user's Guide,
37+
- Getting Started guides,
38+
- Knowledge Base,
39+
- Community Forum.
40+
41+
## Contents
42+
43+
All samples are arranged by four demo projects are according to the development environment:
44+
- WebForms demo project
45+
- MVC demo project
46+
- Client-side JavaScript rendering project
47+
- ASP.NET Core 2.0 over the .NET Framework project (in a separate solution)
48+
49+
ASP.NET Core demo project requires the special setup of your development environment, so you must be familiar with this to get it up and running.
50+
51+
Projects which require a database connection must be configured according to the database server being used.
52+
- Specify the right connection string according to used DBConnection object.
53+
- Choose the syntax and metadata providers which suit your database server and connection method. Read details in this article: [What are the Syntax and Metadata Providers for?](https://support.activequerybuilder.com/hc/en-us/articles/115001063445-What-are-the-Syntax-and-Metadata-providers-for-).
54+
55+
### Getting Started projects
56+
57+
There are some typical basic demos for each of the environments:
58+
- **The Offline project** which doesn't establish a connection to the database, but reads metadata from the pre-generated XML file (usually from the Northwind database).
59+
It is ideal for quick acquaintance with the component.
60+
- **The OLE DB project** which must be configured to connect to a database.
61+
It lets quickly test the component with your database.
62+
- **The Query Results project** gives an idea how Active Query Builder can be integrated into the data browsing facility. It also illustrates the usage of the **CriteriaBuilder control** along with a result data grid.
63+
- **The Edit Sub-Query Text project** explains how to Edit the Sub-query text and preview sub-query results as if it was a standalone query.
64+
65+
### Designing a user-friendly query building environment
66+
Defining friendly names for database objects and fields, adding meaningful objects, customizing database schema tree.
67+
68+
##### Alternate Names
69+
*Active Query Builder lets substitute unreadable names for user-friendly aliases.*
70+
The Alternate Names feature allows for substitution of unintelligible names of database objects and fields for friendly aliases. End-users see the friendly names in the visual query building interface as well as in the query text when editing it manually. The component gets the query with real names back only when you need to execute the query against a database server.
71+
Read more about this feature in the Knowledge Base: [Defining friendly names for database objects and fields](https://support.activequerybuilder.com/hc/en-us/articles/115001063565-User-friendly-database-object-and-field-names).
72+
73+
74+
##### Virtual Objects And Fields
75+
*Add objects which act like views and calculated or lookup fields to your database schema.*
76+
This demo illustrates the ability to add queries as new objects to the Database Schema Tree that act like ordinary database views. Users see virtual objects as ordinary database objects and can use them in their queries without the need to understand their complexity. The same is true for virtual fields: you can add new fields and put complex SQL expressions or correlated sub-queries as their expressions. The users will see them as ordinary fields even in the SQL query text. They will be expanded to corresponding SQL expressions only when you need to execute the query against a database server.
77+
Read more about this feature in the Knowledge Base: [Adding virtual objects and calculated fields to the database schema](https://support.activequerybuilder.com/hc/en-us/articles/115001055269-Virtual-objects-and-calculated-fields).
78+
79+
80+
##### Custom Metadata Structure
81+
*Customize your Database Schema View the way you like: group objects by subject area, define folders with favourite objects, etc.*
82+
This demo gives an idea how to build a custom structure of nodes in the Database Schema Tree: Creation of folders for particular objects (Favorites), folders which contain objects according to a mask, etc.
83+
Read more about this feature: [Customizing the Database Schema Tree structure](https://support.activequerybuilder.com/hc/en-us/articles/115001055289-Customizing-the-Database-Schema-Tree-structure).
84+
85+
##### Toggling Usage of Alternate Names
86+
*Users can see and edit SQL text with both alternate and real object names.*
87+
Advanced SQL writers may wish to turn displaying of friendly aliases off to see the real names in the visual query building interface. This demo project gives the sample for this operation.
88+
89+
90+
### User-defined Queries and Fields
91+
92+
##### Reusable (User-defined) Queries
93+
*Users can save their queries and use them as data sources in subsequent queries.*
94+
The ability to work save queries to the special repository and then use them in subsequent queries the same way as ordinary views is provided by default. The programmer just has to take care of saving and restoring them between work sessions.
95+
96+
##### User-defined Fields
97+
*Let advanced users create own calculated fields.*
98+
This demo introduces the possibility to define calculated fields by end-users.
99+
100+
### User Interface Customizations
101+
102+
##### Custom Expression Editor
103+
*Define own editor to deal with complex SQL expressions.*
104+
This demo adds a button to the in-place editor of Expression and Criteria cells of the Query Columns List and gives the sample of creating a custom editor to edit the cell content in a popup window.
105+
106+
##### SQL Syntax Highlighting
107+
*Highlight SQL syntax using a third-party SQL text editor.*
108+
This demo provides the sample of integration of a third-party SQL text editor to enable SQL syntax highlighting.
109+
110+
111+
##### jQueryUI Theming
112+
*Apply any jQueryUI skin to Active Query Builder UI.*
113+
This demo illustrates run-time switching and appliance of jQueryUI themes.
114+
115+
116+
##### Work without the Design Pane
117+
*Build queries without the design pane by dragging fields right to the Query Columns List.*
118+
This demo implements a visual query building interface without the Design Area. Users build queries by dragging fields from the Database Schema Tree to the Query Columns List and define query column properties, such as grouping, ordering, etc. The appropriate database objects are automatically added to the query, get linked with each other and removed when they aren't needed.
119+
120+
121+
### Metadata Loading
122+
123+
##### Load Metadata Demo
124+
*Four ways to fill the Metadata Container programmatically.*
125+
This demo illustrates various ways of loading metadata information to Active Query Builder.
126+
Metadata handling is described here: [Metadata handling and filtration](https://support.activequerybuilder.com/hc/en-us/sections/115000316525-AQB-for-NET-Metadata-handling-and-filtration).
127+
128+
129+
##### Switch Database Connections
130+
*Switch between different database connections at runtime.*
131+
This demo gives an idea how to get connected to different databases and reload the Database Schema Tree on switching between connections.
132+
133+
### SQL Query Analysis and Modification
134+
135+
##### Query Analysis
136+
*Explore the internal query object model, get summary information about the query.*
137+
This demo contains the code example of a pass through the entire internal query object model.
138+
139+
140+
##### Query Modification
141+
*Modify SQL queries programmatically.*
142+
This demo explains how one can analyze and modify user queries to correct user errors or to limit the data returned by them.
143+
144+
##### Query Creation
145+
*Create SQL queries programmatically from scratch.*
146+
This demo provides code samples of the programmatic creation of various SQL queries.
147+
148+
149+
### Advanced Programming Tasks
150+
151+
##### Handle Query Building Events
152+
*Performing specific actions in the process of building a SQL query.*
153+
This demo gives an idea how to perform custom actions in response to some user actions. The full list of available JavaScript events can be found in this article: [Active Query Builder JavaScript API](https://support.activequerybuilder.com/hc/en-us/articles/115001064225-JavaScript-API-of-Active-Query-Builder-ASP-NET-edition).
154+
155+
##### Handle The Reusable Queries Events
156+
*Performing specific actions in the process of working with Reusable (user-defined) Queries.*
157+
This demo illustrates how to handle addition, renaming and deletion of Reusable Queries, deny or correct user actions.
158+
159+
## License
160+
The source code of the demo projects in this repository is covered by the [MIT license](https://en.wikipedia.org/wiki/MIT_License).

0 commit comments

Comments
 (0)