Shape.Offset Property

Gets or sets the shape position relative to a certain element of the document layout.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

PointF Offset { get; set; }

VB.NET

Property Offset As PointF

Property Value

Type	Description
PointF	A PointF object specifying the offset of the shape measured in current units.

Remarks

The position of a shape is measured from the upper-left corner of the shape’s bounding box. The Shape.RelativeHorizontalPosition and the Shape.RelativeVerticalPosition properties define elements of the document layout from which an offset is measured. If horizontal or vertical alignment is specified (the Shape.HorizontalAlignment or the Shape.VerticalAlignment properties are set to values other than None), the Offset value is disregarded.

This example moves a floating object to a position where its upper left corner is located at 4.5 cm to the right of the left margin and 2 cm below the top margin.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/word-processing-document-api-examples-t418535

ShapesActions.cs

Document document = server.Document;
document.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);
document.Unit = DevExpress.Office.DocumentUnit.Centimeter;
Shape myPicture = document.Shapes[1];
// Clear the qualitative positioning to allow positioning by specifying the numerical offset. 
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.None;
myPicture.VerticalAlignment = ShapeVerticalAlignment.None;
// Specify the reference item for positioning.
myPicture.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.LeftMargin;
myPicture.RelativeVerticalPosition = ShapeRelativeVerticalPosition.TopMargin;
// Specify the offset value.
myPicture.Offset = new System.Drawing.PointF(4.5f, 2.0f);

ShapesActions.vb

Dim document As Document = server.Document
document.LoadDocument("Documents\Grimm.docx", DocumentFormat.OpenXml)
document.Unit = DevExpress.Office.DocumentUnit.Centimeter
Dim myPicture As Shape = document.Shapes(1)
' Clear the qualitative positioning to allow positioning by specifying the numerical offset. 
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.None
myPicture.VerticalAlignment = ShapeVerticalAlignment.None
' Specify the reference item for positioning.
myPicture.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.LeftMargin
myPicture.RelativeVerticalPosition = ShapeRelativeVerticalPosition.TopMargin
' Specify the offset value.
myPicture.Offset = New System.Drawing.PointF(4.5F, 2.0F)

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-with-a-text-or-image-to-the-document-e4184/CS/Form1.cs#L43

shape.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);

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/CS/WindowsFormsApplication1/Form1.cs#L55

shape.RotationAngle = -45;
shape.Offset = new PointF(Convert.ToInt64(currentSection.Page.Width) / 2 - Convert.ToInt64(shape.Size.Width) / 2, Convert.ToInt64(currentSection.Page.Height) / 2 - Convert.ToInt64(shape.Size.Height) / 2);
currentSection.EndUpdateHeader(subDocument);

wpf-richedit-document-api-t213968/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-e5219/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#L39

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

VB.NET

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/VB/Form1.vb#L45

shape.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)

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/VB/WindowsFormsApplication1/Form1.vb#L57

shape.RotationAngle = -45
shape.Offset = New PointF(Convert.ToInt64(currentSection.Page.Width) \ 2 - Convert.ToInt64(shape.Size.Width) \ 2, Convert.ToInt64(currentSection.Page.Height) \ 2 - Convert.ToInt64(shape.Size.Height) \ 2)
currentSection.EndUpdateHeader(subDocument)

wpf-richedit-document-api-t213968/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-e5219/VB/RichEditAPISample/CodeExamples/Shapes.vb#L30

            ' 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#L34

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