dpiAware Element
Progress® Telerik® Reporting R2 2018

dpiAware Element

Telerik Reporting uses the machine DPI settings to determine the physical sizes of report items, images, calculate text sizes and draw the graphic primitives. That's why it is vital to obtain the correct DPI settings of the machine which renders and shows the report in any of the viewers. If the machine's DPI settings are set higher than the default value of 96, it is recommended to make the application DPI-aware, either through an application manifest or by setting the <dpiAware> configuration element, as shown below.

General Information

Usually the DPI awareness is set on the application level through a manifest file, but in some cases such manifest cannot be applied. That's why the reporting engine provides the option to explicitly set the DPI awareness flag prior to rendering the report.

The <dpiAware> section has only one attribute: dpiAwareness. Its value corresponds with the Windows API PROCESS_DPI_AWARENESS enumeration and can be one of the following:

  • PROCESS_DPI_UNAWARE = 0

  • PROCESS_SYSTEM_DPI_AWARE = 1

  • PROCESS_PER_MONITOR_DPI_AWARE = 2

The default value of the dpiAwareness attribute is PROCESS_DPI_UNAWARE_NOT_SET. The current process's DPI awareness is set using the native Windows API function SetProcessDpiAwareness. It is important to note that once the process' DPI awareness is set, every next function call will fail with E_ACCESSDENIED result.

Important note Important

This API function is available on Windows Vista and newer operating systems. If Telerik Reporting is used on a machine with older OS, the DPI awareness would not be set and report rendering might produce unexpected results.

Example

The following snippet shows how to set the current application's DPI awareness to PROCESS_SYSTEM_DPI_AWARE.

<Telerik.Reporting>
...
  <dpiAware dpiAwareness="PROCESS_SYSTEM_DPI_AWARE"></dpiAware>
</Telerik.Reporting>

DPI Awareness in Report Viewers

The following list explains how the DPI awareness is applied in applications, using Telerik Report Viewers:

Windows Forms Report Viewer

The Windows Forms applications are not DPI-aware by default. The recommended approach for declaring an application as DPI-aware is adding a dpiAware element to its application manifest, as shown here.

WPF Report Viewer

The WPF Report Viewer must be used in a WPF application and they are system DPI-aware by default, so no additional settings should be applied. In case you want it to change its awareness to per monitor, please check here here.

HTML5-based Report Viewers

The HTML5-based report viewers are applications, executed in a web server (usually IIS) domain. Instead of applying a custom manifest, the recommended approach is to add the <dpiAware> section to the application's web.config and set the dpiAwareness attribute to PROCESS_SYSTEM_DPI_AWARE.

See Also

Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy