DrawingObject.Offset Property

Gets or sets the absolute position of a shape on the page.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

PointF Offset { get; set; }

VB.NET

Property Offset As PointF

Property Value

Type	Description
PointF	An object that specifies the horizontal and vertical offsets in measurement units defined by the Document.Unit property.

Remarks

Top-Level Shapes

Use the Offset property to specify the absolute position of a floating shape on the page relative to the document elements defined by the Shape.RelativeHorizontalPosition and Shape.RelativeVerticalPosition properties.

Note

The Offset property is in effect when the Shape.HorizontalAlignment and Shape.VerticalAlignment properties are set to None.

The example below creates a rectangle and places it on the page as follows:

• the absolute horizontal position is two inches to the right of the page;

• the absolute vertical position is one inch below the page.

C#

Document document = wordProcessor.Document;
// Set the measurement unit to inches.
document.Unit = DevExpress.Office.DocumentUnit.Inch;
// Create a rectangle.
Shape rectangle = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.Rectangle, new SizeF(2.5f, 1.5f));
// Specify the rectangle position on the page.
rectangle.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Page;
rectangle.RelativeVerticalPosition = ShapeRelativeVerticalPosition.Page;
rectangle.Offset = new PointF(2f, 1f);

VB.NET

Dim document As Document = wordProcessor.Document
' Set the measurement unit to inches.
document.Unit = DevExpress.Office.DocumentUnit.Inch
' Create a rectangle.
Dim rectangle As Shape = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.Rectangle, New SizeF(2.5F, 1.5F))
' Specify the rectangle position on the page.
rectangle.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Page
rectangle.RelativeVerticalPosition = ShapeRelativeVerticalPosition.Page
rectangle.Offset = New PointF(2F, 1F)

Nested Shapes

Use a nested shape’s Offset property to modify its position relative to the top left corner of a parent object (a shape group or a drawing canvas).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Offset 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#

how-to-add-a-watermark-to-the-document/CS/Form1.cs#L43

shape.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto;
shape.Offset = new PointF(section.Page.Width / 2 - shape.Size.Width / 2, section.Page.Height / 2 - shape.Size.Height / 2);
section.EndUpdateHeader(subDocument);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L46

// Specify the offset value.
myPicture.Offset = new System.Drawing.PointF(4.5f, 2.0f);
#endregion #FloatingPictureOffset

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Shapes.cs#L35

// Specify the offset value.
myPicture.Offset = new System.Drawing.PointF(4.5f, 2.0f);
#endregion #FloatingPictureOffset

word-document-api-examples/CS/CodeExamples/ShapesActions.cs#L65

    // Specify the offset value.
    myPicture.Offset = new System.Drawing.PointF(4.5f, 2.0f);
}

VB.NET

how-to-add-a-watermark-to-the-document/VB/Form1.vb#L45

shape.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto
shape.Offset = New PointF(CLng(section.Page.Width) \ 2 - CLng(shape.Size.Width) \ 2, CLng(section.Page.Height) \ 2 - CLng(shape.Size.Height) \ 2)
section.EndUpdateHeader(subDocument)

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/ShapesActions.vb#L39

            ' Specify the offset value.
            myPicture.Offset = New System.Drawing.PointF(4.5F, 2.0F)
'            #End Region ' #FloatingPictureOffset

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Shapes.vb#L32

            ' Specify the offset value.
            myPicture.Offset = New System.Drawing.PointF(4.5F, 2.0F)
#End Region  ' #FloatingPictureOffset

word-document-api-examples/VB/CodeExamples/ShapesActions.vb#L57

    ' Specify the offset value.
    myPicture.Offset = New System.Drawing.PointF(4.5F, 2.0F)
End If