|
1 | | -# GroupDocs.Total for .NET MVC Example |
| 1 | +# GroupDocs.Total for .NET MVC Demo |
2 | 2 |
|
3 | | -[](https://github.com/groupdocs-total/GroupDocs.Total-for-.NET/blob/main/Demos/MVC/LICENSE) |
| 3 | +[](https://github.com/groupdocs-total/GroupDocs.Total-for-.NET/blob/main/LICENSE) |
4 | 4 |
|
5 | 5 | ## System Requirements |
6 | | -- .NET Framework 4.6 |
7 | | -- Visual Studio 2019 and latter |
8 | | - |
9 | | - |
10 | | -## All-in-one document automation API |
11 | | - |
12 | | -**GroupDocs.Total for .NET API** is a suite of powerful, flexible and high-performance libraries which allows you to manipulate documents within your desktop solutions and web apps without requiring any other commercial application. GroupDocs.Total allows you to perform all kinds of operations (view, edit, annotate, sign, compare, convert, merge, search, parse, redact, etc) with **PDF, DOCX, PPT, XLS**, and over 90 other document formats. |
13 | | - |
14 | | -This web application demonstrates the following document manipulation capabilities: |
15 | | - |
16 | | -- Document viewer |
17 | | -- Annotate & write on documents |
18 | | -- Digitally sign documents |
19 | | -- Compare documents |
20 | | -- Convert documents |
21 | | -- Edit documents |
22 | | -- Add, edit or remove metadata |
23 | | - |
24 | | -**Note:** without a license application will run in trial mode, purchase [GroupDocs.Total for .NET license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Total for .NET temporary license](https://purchase.groupdocs.com/temporary-license). |
25 | | - |
26 | | -## Supported document Formats |
27 | | - |
28 | | -| Family | Formats | |
29 | | -|---|:---| |
30 | | -| Portable Document Format | `PDF` | |
31 | | -| Microsoft Word | `DOC`, `DOCM` , `DOCX`, `DOT`, `DOTM`, `DOTX` | |
32 | | -| Microsoft Excel | `XLS`, `XLSB`, `XLSM`, `XLSX`, `XLT`, `XLTM`, `XLTX` | |
33 | | -| Microsoft PowerPoint | `PPT`, `POT`, `POTM`, `POTX`, `PPS`, `PPSM`, `PPSX`, `PPTM`, `PPTX` | |
34 | | -| Microsoft Visio | `VSD`, `VDW`, `VDX`, `VSDX`, `VSS`, `VST`, `VSX`, `VTX` | |
35 | | -| Microsoft Project | `MPP`, `MPT` | |
36 | | -| Microsoft Outlook | `EML`, `EMLX`, `MSG` | |
37 | | -| OpenDocument Formats | `ODT`, `ODP`, `ODS`, `OTT` | |
38 | | -| Plain Text File | `TXT` | |
39 | | -| Comma-Separated Values | `CSV` | |
40 | | -| HyperText Markup Language | `HTML`, `MHT`, `MHTML`, `SVG` | |
41 | | -| Extensible Markup Language | `XML`,`XML`, `XPS` | |
42 | | -| AutoCAD Drawing File Format | `DGN`, `DWG`, `DXF` | |
43 | | -| Image files | `BMP`, `CAL`, `DCX`, `DIB`, `EMF`, `GIF`, `JP2`, `JPG`, `MIL`, `MIL`, `PCD`, `PCT`, `PCX`, `PNG`, `PSD`, `RAS`, `TGA`,`TIFF`,`WMF` | |
44 | | -| Electronic publication | `EPUB` | |
45 | | -| Windows Icon | `ICO` | |
46 | | -| Medical image files | `DCM` | |
47 | | - |
48 | | - |
49 | | -## Features |
50 | | -#### [Document Viewer](https://github.com/groupdocs-viewer/GroupDocs.Viewer-for-.NET-MVC) with GroupDocs.Viewer |
51 | | -- Clean, modern and intuitive design |
52 | | -- Easily switchable colour theme (create your own colour theme in 5 minutes) |
53 | | -- Responsive design |
54 | | -- Mobile support (open application on any mobile device) |
55 | | -- Support over 50 documents and image formats |
56 | | -- HTML and image modes |
57 | | -- Fully customizable navigation panel |
58 | | -- Open password protected documents |
59 | | -- Text searching & highlighting |
60 | | -- Download documents |
61 | | -- Upload documents |
62 | | -- Print document |
63 | | -- Rotate pages |
64 | | -- Zoom in/out documents without quality loss in HTML mode |
65 | | -- Thumbnails |
66 | | -- Smooth page navigation |
67 | | -- Smooth document scrolling |
68 | | -- Preload pages for faster document rendering |
69 | | -- Multi-language support for displaying errors |
70 | | -- Display two or more pages side by side (when zooming out) |
71 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
72 | | -- Cross-platform support (Windows, Linux, MacOS) |
73 | | -#### [Digitally sign documents](https://github.com/groupdocs-signature/GroupDocs.Signature-for-.NET-MVC) with GroupDocs.Signature |
74 | | -- Clean, modern and intuitive design |
75 | | -- Easily switchable colour theme (create your own colour theme in 5 minutes) |
76 | | -- Responsive design |
77 | | -- Mobile support (open application on any mobile device) |
78 | | -- Support over 50 documents and image formats |
79 | | -- Image mode |
80 | | -- Fully customizable navigation panel |
81 | | -- Sign password protected documents |
82 | | -- Download original documents |
83 | | -- Download signed documents |
84 | | -- Upload documents |
85 | | -- Upload signatures |
86 | | -- Sign document with such signature types: digital certificate, image, stamp, qrCode, barCode. |
87 | | -- Draw signature image |
88 | | -- Draw stamp signature |
89 | | -- Generate bar code signature |
90 | | -- Generate qr code signature |
91 | | -- Print document |
92 | | -- Smooth page navigation |
93 | | -- Smooth document scrolling |
94 | | -- Preload pages for faster document rendering |
95 | | -- Multi-language support for displaying errors |
96 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
97 | | -- Cross-platform support (Windows, Linux, MacOS) |
98 | | -#### [Annotate & write on documents](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-.NET-MVC) with GroupDocs.Annotation |
99 | | -- Clean, modern and intuitive design |
100 | | -- Easily switchable colour theme (create your own colour theme in 5 minutes) |
101 | | -- Responsive design |
102 | | -- Mobile support (open application on any mobile device) |
103 | | -- Support over 50 documents and image formats |
104 | | -- Image mode |
105 | | -- Fully customizable navigation panel |
106 | | -- Annotate password protected documents |
107 | | -- Download original documents |
108 | | -- Download annotated documents |
109 | | -- Upload documents |
110 | | -- Annotate document with such annotation types: |
111 | | - * Text |
112 | | - * Area |
113 | | - * Point |
114 | | - * TextStrikeout |
115 | | - * Polyline |
116 | | - * TextField |
117 | | - * Watermark |
118 | | - * TextReplacement |
119 | | - * Arrow |
120 | | - * TextRedaction |
121 | | - * ResourcesRedaction |
122 | | - * TextUnderline |
123 | | - * Distance |
124 | | -- Draw annotation over the document page |
125 | | -- Add comment or reply |
126 | | -- Print document |
127 | | -- Smooth page navigation |
128 | | -- Smooth document scrolling |
129 | | -- Preload pages for faster document rendering |
130 | | -- Multi-language support for displaying errors |
131 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
132 | | -- Cross-platform support (Windows, Linux, MacOS) |
133 | | -#### [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.comparison-for-.NET-MVC) with GroupDocs.Comparison |
134 | | -- Clean, modern and intuitive design |
135 | | -- Easily switchable colour theme (create your own colour theme in 5 minutes) |
136 | | -- Responsive design |
137 | | -- Mobile support (open application on any mobile device) |
138 | | -- HTML and image modes |
139 | | -- Fully customizable navigation panel |
140 | | -- Compare documents |
141 | | -- Multi-compare several documents |
142 | | -- Compare password protected documents |
143 | | -- Upload documents |
144 | | -- Display clearly visible differences |
145 | | -- Download comparison results |
146 | | -- Print comparison results |
147 | | -- Smooth document scrolling |
148 | | -- Preload pages for faster document rendering |
149 | | -- Multi-language support for displaying errors |
150 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
151 | | -- Cross-platform support (Windows, Linux, MacOS) |
152 | | -#### [Document converter](https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-.NET-MVC) with GroupDocs.Conversion |
153 | | -- Clean, modern and intuitive design |
154 | | -- Easily switchable colour theme (create your own colour theme in 5 minutes) |
155 | | -- Responsive design |
156 | | -- Convert individual documents |
157 | | -- Batch convert multiple documents |
158 | | -- Drag and drop support |
159 | | -- Mobile support (open application on any mobile device) |
160 | | -- HTML and image modes |
161 | | -- Upload documents |
162 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
163 | | -- Cross-platform support (Windows, Linux, MacOS) |
164 | | -#### [Document editor](https://github.com/groupdocs-conversion/GroupDocs.Editor-for-.NET-MVC) with GroupDocs.Editor |
165 | | -- Responsive design |
166 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
167 | | -- Cross-platform support (Windows, Linux, MacOS) |
168 | | -- Clean, modern and intuitive design |
169 | | -- Edit, format documents |
170 | | -- Mobile support (open application on any mobile device) |
171 | | -- Support over 50 documents and image formats including **DOCX**, **ODT**, **XLS** |
172 | | -- Fully customizable navigation panel |
173 | | -- Open password protected documents |
174 | | -- Download documents |
175 | | -- Upload documents |
176 | | -- Print document |
177 | | -#### [Add, edit or remove metadata](https://github.com/groupdocs-metadata/GroupDocs.Metadata-for-.NET-MVC) with GroupDocs.Metadata |
178 | | -- Add Metadata to Office Documents |
179 | | -- Edit or update Metadata in Office Documents |
180 | | -- Remove Metadata from Office Documents |
181 | | -- Clean, modern and intuitive design |
182 | | -- Easily switchable colour theme (create your own colour theme in 5 minutes) |
183 | | -- Responsive design |
184 | | -- Mobile support (open application on any mobile device) |
185 | | -- Support over 50 documents and image formats |
186 | | -- Fully customizable navigation panel |
187 | | -- Open password protected documents |
188 | | -- Download documents |
189 | | -- Upload documents |
190 | | -- Print document |
191 | | -- Smooth document scrolling |
192 | | -- Multi-language support for displaying errors |
193 | | -- Cross-browser support (Safari, Chrome, Opera, Firefox) |
194 | | -- Cross-platform support (Windows, Linux, MacOS) |
195 | | - |
196 | | -## How to run |
197 | | - |
198 | | -You can run this sample by one of following methods |
199 | | - |
200 | | -### Build from source |
201 | | - |
202 | | -Download [source code](https://github.com/groupdocs-total/GroupDocs.Total-for-.NET/archive/refs/heads/main.zip) from github or clone this repository. |
203 | 6 |
|
204 | | -```bash |
205 | | -git clone https://github.com/groupdocs-total/GroupDocs.Total-for-.NET |
206 | | -``` |
| 7 | +- .NET Framework 4.8 |
| 8 | +- Visual Studio 2022 or later |
| 9 | + |
| 10 | +## Overview |
207 | 11 |
|
208 | | -Open solution in the VisualStudio. |
209 | | -Update common parameters in `web.config` and example related properties in the `configuration.yml` to meet your requirements. |
| 12 | +ASP.NET MVC 5 demo application showcasing [GroupDocs.Total for .NET](https://products.groupdocs.com/total/net/) document manipulation capabilities: |
210 | 13 |
|
211 | | -Open http://localhost:8080/ in your favorite browser |
| 14 | +- Document viewing (GroupDocs.Viewer) |
| 15 | +- Annotation (GroupDocs.Annotation) |
| 16 | +- Digital signatures (GroupDocs.Signature) |
| 17 | +- Document comparison (GroupDocs.Comparison) |
| 18 | +- Document conversion (GroupDocs.Conversion) |
| 19 | +- Document editing (GroupDocs.Editor) |
| 20 | +- Metadata management (GroupDocs.Metadata) |
| 21 | +- Full-text search (GroupDocs.Search) |
212 | 22 |
|
213 | | -### Docker image |
214 | | -Use [docker image](https://hub.docker.com/u/groupdocs). |
| 23 | +**Note:** Without a license the application runs in trial mode. You can [request a temporary license](https://purchase.groupdocs.com/temporary-license). |
| 24 | + |
| 25 | +## How to Run |
215 | 26 |
|
216 | 27 | ```bash |
217 | | -mkdir DocumentSamples |
218 | | -mkdir Licenses |
219 | | -docker run -p 8080:8080 --env application.hostAddress=localhost -v `pwd`/DocumentSamples:/home/groupdocs/app/DocumentSamples -v `pwd`/Licenses:/home/groupdocs/app/Licenses groupdocs/total |
220 | | -## Open http://localhost:8080/ in your favorite browser. |
| 28 | +git clone https://github.com/groupdocs-total/GroupDocs.Total-for-.NET |
221 | 29 | ``` |
222 | 30 |
|
223 | | -### Configuration |
224 | | -For all methods above you can adjust settings in `configuration.yml`. By default in this sample will lookup for license file in `./Licenses` folder, so you can simply put your license file in that folder or specify relative/absolute path by setting `licensePath` value in `configuration.yml`. |
| 31 | +1. Open `Demos/MVC/GroupDocs.Total MVC.sln` in Visual Studio |
| 32 | +2. Build and run |
| 33 | +3. Open http://localhost:8080/ |
225 | 34 |
|
226 | | -## Troubleshooting |
227 | | -### How to set custom baseURL |
228 | | -BaseURL is fetched from address bar however you can set custom baseURL by adding *forRoot* parameter at [app.module.ts](https://github.com/groupdocs-total/GroupDocs.Total-for-NET-MVC/blob/master/src/client/apps/viewer/src/app/app.module.ts#L9) |
| 35 | +## Project Structure |
229 | 36 |
|
230 | | -**Example:** |
231 | | -```js |
232 | | -ViewerModule.forRoot("http://localhost:8080") |
| 37 | +``` |
| 38 | +src/ |
| 39 | + Client/ - Frontend assets (Angular bundles, CSS, images) |
| 40 | + Controllers/ - MVC controllers |
| 41 | + Files/ - Sample documents for each product |
| 42 | + Products/ - Business logic per product (config, API controllers, services) |
| 43 | + Views/ - Razor views |
| 44 | + Web.config - Application configuration |
233 | 45 | ``` |
234 | 46 |
|
235 | | -## License |
236 | | -The MIT License (MIT). |
| 47 | +## Configuration |
237 | 48 |
|
238 | | -Please have a look at the LICENSE.md for more details |
| 49 | +Settings use `appSettings` in `Web.config` with `section:property` keys. All settings have sensible defaults. |
239 | 50 |
|
240 | | -## GroupDocs Total on other platforms & frameworks |
| 51 | +```xml |
| 52 | +<appSettings> |
| 53 | + <add key="viewer:filesDirectory" value="C:\MyFiles\Viewer" /> |
| 54 | + <add key="application:licensePath" value="C:\path\to\license.lic" /> |
| 55 | +</appSettings> |
| 56 | +``` |
| 57 | + |
| 58 | +By default, license files are loaded from the `Licenses/` folder. |
241 | 59 |
|
242 | | -- [GroupDocs.Total with Java Spring ](https://github.com/groupdocs-total/GroupDocs.Total-for-Java/tree/main/Demos/Spring) |
243 | | -- [GroupDocs.Total with Java Dropwizard ](https://github.com/groupdocs-total/GroupDocs.Total-for-Java/tree/main/Demos/Dropwizard) |
244 | | -- [GroupDocs.Total with .NET WebForms ](https://github.com/groupdocs-total/GroupDocs.Total-for-.NET/tree/main/Demos/WebForms) |
| 60 | +## Other Demo Apps |
| 61 | + |
| 62 | +- [GroupDocs.Total for .NET WebForms](https://github.com/groupdocs-total/GroupDocs.Total-for-.NET/tree/main/Demos/WebForms) |
| 63 | +- [GroupDocs.Total for Java Spring](https://github.com/groupdocs-total/GroupDocs.Total-for-Java/tree/main/Demos/Spring) |
| 64 | +- [GroupDocs.Total for Java Dropwizard](https://github.com/groupdocs-total/GroupDocs.Total-for-Java/tree/main/Demos/Dropwizard) |
245 | 65 |
|
246 | 66 | ## Resources |
247 | | -- **Website:** [www.groupdocs.com](http://www.groupdocs.com) |
| 67 | + |
248 | 68 | - **Product Home:** [GroupDocs.Total for .NET](https://products.groupdocs.com/total/net/) |
249 | | -- **Product API References:** [GroupDocs API](https://apireference.groupdocs.com) |
250 | | -- **Download:** [Download GroupDocs.Total for .NET](https://releases.groupdocs.com/total/net/) |
251 | | -- **Documentation:** [GroupDocs.Total for .NET Documentation](https://docs.groupdocs.com/total/) |
252 | | -- **Free Support Forum:** [GroupDocs.Total for .NET Free Support Forum](https://forum.groupdocs.com/c/total) |
253 | | -- **Paid Support Helpdesk:** [GroupDocs.Total for .NET Paid Support Helpdesk](https://helpdesk.groupdocs.com) |
254 | | -- **Blog:** [GroupDocs.Total for .NET Blog](https://blog.groupdocs.com/category/groupdocs-total-product-family) |
| 69 | +- **Documentation:** [GroupDocs.Total Documentation](https://docs.groupdocs.com/total/) |
| 70 | +- **API References:** [GroupDocs API](https://apireference.groupdocs.com) |
| 71 | +- **Download:** [NuGet Package](https://releases.groupdocs.com/total/net/) |
| 72 | +- **Free Support:** [Forum](https://forum.groupdocs.com/c/total) |
| 73 | +- **Paid Support:** [Helpdesk](https://helpdesk.groupdocs.com) |
| 74 | + |
| 75 | +## License |
| 76 | + |
| 77 | +The MIT License (MIT). See the [LICENSE](https://github.com/groupdocs-total/GroupDocs.Total-for-.NET/blob/main/LICENSE) for details. |
0 commit comments