ISpreadsheetComponent.Unit Property

Gets or sets a unit of measure used in the workbook.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

DocumentUnit Unit { get; set; }

VB.NET

Property Unit As DocumentUnit

Property Value

Type	Description
DocumentUnit	The DocumentUnit enumeration member. It is expected to be set to the DocumentUnit.Document value by default.

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

By default, all workbooks loaded in the SpreadsheetControl gets the unit of measurement from the SpreadsheetControl.Unit property value. To specify the unit of measurement for the workbook explicitly, use the SpreadsheetControl.Document.Unit notation.

When the unit of measurement is changed, the ISpreadsheetComponent.UnitChanging and ISpreadsheetComponent.UnitChanged events occur.

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#

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/PictureActions.cs#L31

// Set the measurement unit to Millimeter.
workbook.Unit = DevExpress.Office.DocumentUnit.Millimeter;
try

wpf-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_WPF_API_Part03/MainWindow.xaml.cs#L55

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

wpf-spreadsheet-chart-api/CS/SpreadsheetWPFChartAPISamples/CodeExamples/ChartSheetActions.cs#L139

Worksheet worksheet = workbook.Worksheets["chartTask1"];
workbook.Unit = DevExpress.Office.DocumentUnit.Inch;

wpf-spreadsheetcontrol-api-part-1/CS/SpreadsheetControl_WPF_API/SpreadsheetActions/FormattingActions.cs#L386

range.ColumnWidthInCharacters = 30;
workbook.Unit = DevExpress.Office.DocumentUnit.Inch;
range.RowHeight = 1;

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/Form1.cs#L374

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

VB.NET

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/PictureActions.vb#L33

' Set the measurement unit to Millimeter.
workbook.Unit = DevExpress.Office.DocumentUnit.Millimeter
Try

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ShapeActions.vb#L27

' Set the measurement unit to Millimeter.
workbook.Unit = DevExpress.Office.DocumentUnit.Millimeter
Try

wpf-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_WPF_API_Part03/MainWindow.xaml.vb#L56

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

wpf-spreadsheet-chart-api/VB/SpreadsheetWPFChartAPISamples/CodeExamples/ChartSheetActions.vb#L134

Dim worksheet As Worksheet = workbook.Worksheets("chartTask1")
workbook.Unit = DevExpress.Office.DocumentUnit.Inch

wpf-spreadsheetcontrol-api-part-1/VB/SpreadsheetControl_WPF_API/SpreadsheetActions/FormattingActions.vb#L372

range.ColumnWidthInCharacters = 30
workbook.Unit = DevExpress.Office.DocumentUnit.Inch
range.RowHeight = 1