DocumentViewerBase.UseDirectXPaint Property

Specifies whether the Document Viewer control uses the DirectX Hardware Acceleration.

Namespace: DevExpress.DocumentView.Controls

Assembly: DevExpress.Utils.v21.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Win.Design, DevExpress.Wpf.Core

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Appearance")]
public virtual DefaultBoolean UseDirectXPaint { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<DXCategory("Appearance")>
Public Overridable Property UseDirectXPaint As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	True, to enable the DirectX Hardware Acceleration for the Document Viewer control; otherwise, False. The Default value is equivalent to False.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

The GDI+ library is the default rendering engine for the Document Viewer control. If a viewer displays a document that contains many pages, this engine might render this document slowly. You can switch to the DirectX rendering engine to boost rendering performance. For this, enable the viewer’s UseDirectXPaint property. You can set the viewer’s EnableSmoothScrolling property to True to allow for more smooth page scrolling in DirectX mode. Note that smooth scrolling might require more application resources to render the pages.

The following limitations apply to the viewer when it uses DirectX rendering:

• The Cached Report Source component is not supported.
• The XRRichText control is rendered as an image. The default GDI+ library is used to render this control.
• String sizes in a document might be greater compared with the case when the GDI+ library is used to render the document.