You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc-output/configure-the-report-engine/typereferences-element.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
-
title: TypeReferences Element
3
-
page_title: TypeReferences Element Configuration
4
-
description: "Learn how to set up the TypeReferences Element, allowing you to use custom user functions in the report and create ObjectDataSource components."
2
+
title: typeReferences Element
3
+
page_title: typeReferences Element Configuration
4
+
description: "Learn how to set up the typeReferences Element, allowing you to use custom user functions in the report and create ObjectDataSource components."
>note This element was first introduced in the [2024 Q1 (18.0.24.305)](https://www.telerik.com/support/whats-new/reporting/release-history/progress-telerik-reporting-2024-q1-(18-0-24-305)) Reporting version.
23
23
24
-
Defines a collection of type references used by the Reporting Engine to resolve the custom types permitted to be used during the design and processing stages. The assemblies used by the types in TypeReferences section are loaded into application domain if the type is successfully resolved, so it's not necessary to declare the assembly also in the AssemblyReferences section.
24
+
Defines a collection of type references used by the Reporting Engine to resolve the custom types permitted to be used during the design and processing stages. The assemblies used by the types in the typeReferences section are loaded into the application domain if the type is successfully resolved, so it's not necessary to declare the assembly also in the AssemblyReferences section.
25
25
26
26
XML-based configuration file:
27
27
@@ -36,7 +36,7 @@ XML-based configuration file:
36
36
JSON-based configuration file:
37
37
38
38
````JSON
39
-
"TypeReferences": [
39
+
"typeReferences": [
40
40
],
41
41
````
42
42
@@ -46,11 +46,11 @@ The following sections describe attributes, child elements, and parent elements.
46
46
47
47
|||
48
48
| ------ | ------ |
49
-
|Attributes|<ul><li>__typeName__ – mandatory string attribute. Specifies the full name of the type, i.e. namespace and class name.</li><li>__assemblyName__ – mandatory string attribute. Specifies the name of the assembly that contains the type.</li><li>__publicKeyToken__ – optional string attribute. Specifies the public key token of the assembly. Can be omitted or can have empty or null value.</li></ul>|
49
+
|Attributes|<ul><li>__typeName__ – mandatory string attribute. Specifies the full name of the type, i.e., namespace and class name.</li><li>__assemblyName__ – mandatory string attribute. Specifies the name of the assembly that contains the type.</li><li>__publicKeyToken__ – optional string attribute. Specifies the public key token of the assembly. Can be omitted or can have an empty or null value.</li></ul>|
50
50
|Child Elements|<ul><li>__add__ - Optional element. Adds a type reference to the collection.</li><li>__clear__ - Optional element. Removes all references to inherited type names, allowing only the references that are added by the current add element.</li><li>__remove__ - Optional element. Removes a reference to an inherited type name from the collection.</li></ul>|
51
51
|Parent Elements|<ul><li>__configuration__ - Specifies the root element in every configuration file that is used by the common language runtime and the .NET Framework applications.</li><li>__Telerik.Reporting__ - Configures all settings that Telerik Reporting Engine uses.</li></ul>|
52
52
53
-
When providing the Public Key Token, the Reporting Engine will try to match it with the Public Key Token of the found DLL. It will not load an assembly with the same name and a different Public Key Token and will throw an exception instead. If the Public Key Token is omitted in the configuration, the Reporting Engine will load the first DLL, which name matches the provided Assembly Name. Potentially, this may allow bad agents to replace trusted assemblies with malicious ones and constitutes a security vulnerability. Since the Public Key Token provides an extra security layer to your application, we advise to always include it in the configuration file.
53
+
When providing the Public Key Token, the Reporting Engine will try to match it with the Public Key Token of the found DLL. It will not load an assembly with the same name and a different Public Key Token and will throw an exception instead. If the Public Key Token is omitted in the configuration, the Reporting Engine will load the first DLL, whose name matches the provided Assembly Name. Potentially, this may allow bad agents to replace trusted assemblies with malicious ones and constitutes a security vulnerability. Since the Public Key Token provides an extra security layer to your application, we advise always including it in the configuration file.
54
54
55
55
## Example
56
56
@@ -77,7 +77,7 @@ JSON-based configuration file:
77
77
78
78
````JSON
79
79
"telerikReporting": {
80
-
"TypeReferences": [
80
+
"typeReferences": [
81
81
{
82
82
"typeName": "MyNamespace.MyClassName",
83
83
"assemblyName": "MyAssemblyName",
@@ -87,7 +87,7 @@ JSON-based configuration file:
87
87
}
88
88
````
89
89
90
-
> When adding the `Telerik.Reporting` section manually, do not forget to register it in `configSections` element of the configuration file. Failing to do so will result in a [ConfigurationErrorsException](https://learn.microsoft.com/en-us/dotnet/api/system.configuration.configurationerrorsexception?view=dotnet-plat-ext-7.0) with the following text: *Configuration system failed to initialize*.
90
+
> When adding the `Telerik.Reporting` section manually, do not forget to register it in the `configSections` element of the configuration file. Failing to do so will result in a [ConfigurationErrorsException](https://learn.microsoft.com/en-us/dotnet/api/system.configuration.configurationerrorsexception?view=dotnet-plat-ext-7.0) with the following text: *Configuration system failed to initialize*.
>* The Chart report item is now superseded by the more advanced [Graph]({%slug telerikreporting/designing-reports/report-structure/graph/overview%}) report item. The Graph is most often used for building powerful OLAP and Pivot charts.
15
15
>* The Chart report item is not supported in .NET Core projects and in projects deployed on Azure.
16
16
>* The complete Chart report item documentation is available as a `CHM` file up to Telerik Reporting version 8.2.14.1204, and can be downloaded from [your Telerik account](https://www.telerik.com/account/downloads/product-download?product=REPORTING).
17
+
>* If your reports utilize the Chart item, you need to add a [typeReference]({%slug telerikreporting/using-reports-in-applications/export-and-configure/configure-the-report-engine/typeReferences-element%}) in your configuration to explicitly allow the element to be processed: `<add typeName="Telerik.Reporting.Processing.Chart" assemblyName="Telerik.Reporting" publicKeyToken="a9d7983dfcc261be" />`. This is required due to vulnerabilities in the item code.
17
18
18
19
The Chart report item is used to display a chart on a report.
0 commit comments