Back to Devexpress

Shape.OffsetRelative Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-shape-42357358.md

latest3.7 KB
Original Source

Shape.OffsetRelative Property

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

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
PointF OffsetRelative { get; set; }
vb
Property OffsetRelative As PointF

Property Value

TypeDescription
PointF

An object that defines the horizontal and vertical offsets (in percentage) relative to the specified elements. Valid values range from -10 (-1000%) to 10 (1000%).

|

Remarks

Use the OffsetRelative property to specify a floating shape’s position (in percentage) relative to the document elements defined by the Shape.RelativeHorizontalPosition and Shape.RelativeVerticalPosition properties.

Note

The OffsetRelative 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 horizontal offset is equal to 20% of the page width,

  • the vertical offset is equal to 10% of the page height.

  • C#

  • VB.NET

csharp
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.OffsetRelative = new PointF(0.2f, 0.1f);
vb
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.OffsetRelative = New PointF(0.2F, 0.1F)

See Also

RelativeHorizontalPosition

RelativeVerticalPosition

OffsetXRelative

OffsetYRelative

Shape Interface

Shape Members

DevExpress.XtraRichEdit.API.Native Namespace