Document.Unit Property

Gets or sets a document’s measure units.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v22.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

DocumentUnit Unit { get; set; }

VB.NET

Property Unit As DocumentUnit

Property Value

Type	Description
DocumentUnit	One of the DocumentUnit enumeration values indicating the measure unit.

Available values:

Name	Description
Document	Specifies documents (one three-hundredths of an inch) as measurement units.
Inch	Specifies inches as measurement units.
Millimeter	Specifies millimeters as measurement units.
Centimeter	Specifies centimeters as measurement units.
Point	Specifies points as measurement units.

Remarks

The Unit property specifies almost all properties involving linear measurements. The default unit of measurement is the DocumentUnit.Document.

Changing the Unit value recalculates all related properties as well. Specify the Unit property before setting target linear measurements.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Unit property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/PageLayoutActions.cs#L16

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
document.Unit = DevExpress.Office.DocumentUnit.Inch;
Section sec = document.Sections[0];

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/PageLayout.cs#L16

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
document.Unit = DevExpress.Office.DocumentUnit.Inch;
Section sec = document.Sections[0];

word-document-api-examples/CS/CodeExamples/PageLayoutActions.cs#L28

// Specify the document’s measure units.
document.Unit = DevExpress.Office.DocumentUnit.Inch;

how-to-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/CS/TabStops/Form1.cs#L26

#region #tabs
richEditControl1.Document.Unit = DevExpress.Office.DocumentUnit.Inch;
TabInfoCollection tabs = richEditControl1.Document.Paragraphs[0].BeginUpdateTabs(true);

inline-pictures-in-richeditcontrol-e1525/CS/InlinePictures/Form1.cs#L65

#region #scaledown
richEditControl1.Document.Unit =
    DevExpress.Office.DocumentUnit.Millimeter;

VB.NET

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/PageLayoutActions.vb#L13

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
document.Unit = DevExpress.Office.DocumentUnit.Inch
Dim sec As Section = document.Sections(0)

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/PageLayout.vb#L15

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
document.Unit = DevExpress.Office.DocumentUnit.Inch
Dim sec As DevExpress.XtraRichEdit.API.Native.Section = document.Sections(0)

word-document-api-examples/VB/CodeExamples/PageLayoutActions.vb#L28

' Specify the document’s measure units.
document.Unit = DevExpress.Office.DocumentUnit.Inch
' Access the first document section.

how-to-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/VB/TabStops/Form1.vb#L24

'            #Region "#tabs"
            richEditControl1.Document.Unit = DevExpress.Office.DocumentUnit.Inch
            Dim tabs As TabInfoCollection = richEditControl1.Document.Paragraphs(0).BeginUpdateTabs(True)

inline-pictures-in-richeditcontrol-e1525/VB/InlinePictures/Form1.vb#L65

'#Region "#scaledown"
richEditControl1.Document.Unit = DevExpress.Office.DocumentUnit.Millimeter
Dim images As ReadOnlyDocumentImageCollection = richEditControl1.Document.Images.Get(richEditControl1.Document.Range)