Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit af586fd

Browse filesBrowse files
Update Html5Viewer main articles
1 parent 4d4d19b commit af586fd
Copy full SHA for af586fd

File tree

1 file changed

+13
-143
lines changed
Filter options
  • embedding-reports/display-reports-in-applications/web-application/html5-report-viewer

1 file changed

+13
-143
lines changed

‎embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/manual-setup.md

Copy file name to clipboardExpand all lines: embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/manual-setup.md
+13-143Lines changed: 13 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -26,193 +26,63 @@ Before you continue, make sure that the following prerequisites are met:
2626

2727
## Utilizing the HTML5 Report Viewer in an HTML page
2828

29-
The following steps produce an HTML page with settings similar to these of the local Html5Demo project installed by default under __[TelerikReporting_InstallDir]\Examples__:
29+
The following steps produce an HTML page with settings similar to those of the local HTML5Demo project installed by default under __[TelerikReporting_InstallDir]\Examples__:
3030

3131
> You must adapt all path references in the steps below to your project setup. For more information, refer to the [ASP.NET Web Project Paths](https://learn.microsoft.com/en-us/previous-versions/ms178116(v=vs.140)) Microsoft article.
3232
3333
1. Create an HTML5 page:
3434

35-
````HTML
36-
<!DOCTYPE html>
37-
<html xmlns="http://www.w3.org/1999/xhtml">
38-
<head>
39-
<title>Telerik HTML5 Report Viewer</title>
40-
</head>
41-
<body>
42-
</body>
43-
</html>
44-
````
35+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\CreateHtmlPage.html}}
4536

4637
>The above DOCTYPE directive must reflect your custom requirements. You can find more details about the page settings used in this tutorial in the [Defining document compatibility](https://learn.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/compatibility/cc288325(v=vs.85)) Microsoft article.
4738

4839
1. Initialize the browser’s viewport in the `<head>` element:
4940

50-
````HTML
51-
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
52-
````
41+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\InitializeViewport.html}}
5342

5443
The viewport META tag is used to control the layout on mobile browsers.
5544

5645
1. Add a reference to jQuery in the `<head>` element:
5746

58-
````HTML
59-
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
60-
````
47+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddjQuery.html}}
6148

6249
>jQuery must be loaded before creating the viewer object.jQuery must be loaded only once on the page.
6350

6451
1. Add references to the Telerik Kendo UI styles in the `<head>` element:
6552

66-
````HTML
67-
<!-- the required Kendo styles -->
68-
<link href="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/styles/kendo.common.min.css" rel="stylesheet" />
69-
<link href="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/styles/kendo.blueopal.min.css" rel="stylesheet" />
70-
````
71-
53+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddKendoStyles.html}}
7254

7355
1. Add references to the HTML5 Report Viewer JavaScript file in the `<head>` element:
7456

75-
````HTML
76-
<script src="/api/reports/resources/js/telerikReportViewer"></script>
77-
````
57+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddTrvJavaScript.html}}
7858

7959
>The report viewer JavaScript must be referenced after any other Kendo widgets or bundles.
8060

8161
If no Kendo widgets are utilized on the page, the report viewer will register a custom Kendo subset to enable the required Kendo widgets. The subset is served from the report service. If Kendo is used on the page or the CDN is preferred, make sure the following widgets are referenced:
8262

83-
````HTML
84-
<!--
85-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.core.min.js"></script>
86-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.data.odata.min.js"></script>
87-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.data.min.js"></script>
88-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.userevents.min.js"></script>
89-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.selectable.min.js"></script>
90-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.calendar.min.js"></script>
91-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.fx.min.js"></script>
92-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.draganddrop.min.js"></script>
93-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.mobile.scroller.min.js"></script>
94-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.virtuallist.min.js"></script>
95-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.popup.min.js"></script>
96-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.list.min.js"></script>
97-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.combobox.min.js"></script>
98-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.datepicker.min.js"></script>
99-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.resizable.min.js"></script>
100-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.dropdownlist.min.js"></script>
101-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.multiselect.min.js"></script>
102-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.splitter.min.js"></script>
103-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.window.min.js"></script>
104-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.color.min.js"></script>
105-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.slider.min.js"></script>
106-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.button.min.js"></script>
107-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.colorpicker.min.js"></script>
108-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.editor.min.js"></script>
109-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.listview.min.js"></script>
110-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.menu.min.js"></script>
111-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.panelbar.min.js"></script>
112-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.tooltip.min.js"></script>
113-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.treeview.min.js"></script>
114-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.touch.min.js"></script>
115-
kendo.mobile.min.js - optional, if gestures/touch support is required
116-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.mobile.min.js"></script>
117-
kendo.all.min.js or kendo.web.min.js can be used as well if Kendo is used outside the report viewer
118-
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.web.min.js"></script>
119-
-->
120-
````
121-
63+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddTrvKendoWidgets.html}}
12264

12365
1. Add a `<div>` element to the `<body>` element that will serve as a placeholder for the viewer’s widget. The `<div>` element's ID attribute serves as a key(Id) for the viewer object. Its content (*loading...*) will be displayed while the viewer’s content is being loaded (from the template):
12466

125-
````HTML
126-
<div id="reportViewer1" class="k-widget">
127-
loading...
128-
</div>
129-
````
130-
67+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddTrvPlaceHolder.html}}
13168

13269
1. Add the following script element at the bottom of the `<body>` element and create the HTML5 Report Viewer widget for the reportViewer1 `<div>` element that we just added:
13370

134-
````JS
135-
<script type="text/javascript">
136-
$("#reportViewer1")
137-
.telerik_ReportViewer({
138-
serviceUrl: "/api/reports/",
139-
//templateUrl: /ReportViewer/templates/telerikReportViewerTemplate-FA-{{buildversion}}.html
140-
reportSource: {
141-
report: "Telerik.Reporting.Examples.CSharp.ProductCatalog, CSharp.ReportLibrary",
142-
parameters: {
143-
CultureID: "en"
144-
}
145-
}
146-
});
147-
</script>
148-
````
71+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddTrv.html}}
14972

15073
The relative paths that you use must reflect the project's structure. The default template uses TelerikWebUI icons. If you prefer a template with *FontAwesome* icons, you have to set the templateUrl option to `/ReportViewer/templates/telerikReportViewerTemplate-FA-{{site.buildversion}}.html`.
15174

15275
>The viewer's __reportSource__ consists of report and parameters attributes, where __report__ is the string description of the report that will be displayed, and __parameters__ is a collection of parameter keys and values that will be sent to the report. The report's string description is handled on the server by the [report source resolver used in the Reporting REST service]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-service-report-source-resolver/overview%}). The above example uses the [assembly qualified name](https://learn.microsoft.com/en-us/dotnet/api/system.type.assemblyqualifiedname?view=net-7.0#System_Type_AssemblyQualifiedName) of a report's type (report created in Visual Studio Report Designer). This string description will be handled automatically by the [ReportTypeResolver](/api/Telerik.Reporting.Services.WebApi.ReportTypeResolver).
15376

15477
1. Make the viewer fill the entire browser window. Add the following style to the `<head>` element:
15578

156-
````HTML
157-
<style>
158-
#reportViewer1 {
159-
position: absolute;
160-
left: 5px;
161-
right: 5px;
162-
top: 5px;
163-
bottom: 5px;
164-
font-family: 'segoe ui', 'ms sans serif';
165-
overflow: hidden;
166-
}
167-
</style>
168-
````
169-
170-
>The above CSS rule will be applied on the `<div>` element holding the viewer object. The HTML elements building the viewer object will be sized based on the size of this container `<div>` element. To make the viewer fit in another container, use *position:relative* and provide width and height values.
79+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\AddTrvStyles.html}}
17180

172-
1. The HTML page that we have just created should look like this:
81+
>The above CSS rule will be applied to the `<div>` element holding the viewer object. The HTML elements building the viewer object will be sized based on the size of this container `<div>` element. To make the viewer fit in another container, use *position:relative* and provide width and height values.
17382

174-
````HTML
175-
<!DOCTYPE html>
176-
<html xmlns="http://www.w3.org/1999/xhtml">
177-
<head>
178-
<title>Telerik HTML5 Report Viewer</title>
179-
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
180-
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
181-
<link href="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/styles/kendo.common.min.css" rel="stylesheet" />
182-
<link href="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/styles/kendo.blueopal.min.css" rel="stylesheet" />
183-
<script src="/api/reports/resources/js/telerikReportViewer"></script>
184-
<style>
185-
#reportViewer1 {
186-
position: absolute;
187-
left: 5px;
188-
right: 5px;
189-
top: 5px;
190-
bottom: 5px;
191-
font-family: 'segoe ui', 'ms sans serif';
192-
overflow: hidden;
193-
}
194-
</style>
195-
</head>
196-
<body>
197-
<div id="reportViewer1" class="k-widget">
198-
loading...
199-
</div>
200-
<script type="text/javascript">
201-
$("#reportViewer1")
202-
.telerik_ReportViewer({
203-
serviceUrl: "/api/reports/",
204-
reportSource: {
205-
report: "Telerik.Reporting.Examples.CSharp.ProductCatalog, CSharp.ReportLibrary",
206-
parameters: {
207-
CultureID: "en"
208-
}
209-
}
210-
});
211-
</script>
212-
</body>
213-
</html>
214-
````
83+
1. The HTML page that we have just created should look like this:
21584

85+
{{source=CodeSnippets\BlazorAppSnippets\wwwroot\manual-setup\TrvPage.html}}
21686

21787
1. Run the project and navigate to the page with the HTML5 Report Viewer that we have just created.
21888

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.