Back to Devexpress

Document.Unit Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-9584fab7.md

latest5.6 KB
Original Source

Document.Unit Property

Gets or sets a document’s measure units.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
DocumentUnit Unit { get; set; }
vb
Property Unit As DocumentUnit

Property Value

TypeDescription
DocumentUnit

One of the DocumentUnit enumeration values indicating the measure unit.

|

Available values:

NameDescription
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.

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.

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

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

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

csharp
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#L25

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

winforms-richeditcontrol-common-api/CS/RichEditAPISample/Form1.cs#L402

csharp
richEditControl.CreateNewDocument();
document.Unit = DevExpress.Office.DocumentUnit.Document;
document.EndUpdate();

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

vb
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)

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

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

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

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

winforms-richeditcontrol-common-api/VB/RichEditAPISample/Form1.vb#L392

vb
richEditControl.CreateNewDocument()
document.Unit = DevExpress.Office.DocumentUnit.Document
document.EndUpdate()

See Also

Document Interface

Document Members

DevExpress.XtraRichEdit.API.Native Namespace