Shape.HorizontalAlignment Property

Gets or sets how the shape is positioned horizontally.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

ShapeHorizontalAlignment HorizontalAlignment { get; set; }

VB.NET

Property HorizontalAlignment As ShapeHorizontalAlignment

Property Value

Type	Description
ShapeHorizontalAlignment	A ShapeHorizontalAlignment enumeration member that specifies the shape’s horizontal position.

Available values:

Name	Description
None	The shape is positioned explicitly via the Shape.Offset property relative to its Shape.RelativeHorizontalPosition.
Left	The shape is left-aligned relative to its Shape.RelativeHorizontalPosition.
Center	The shape is centered relative to its Shape.RelativeHorizontalPosition.
Right	The shape is right-aligned relative to its Shape.RelativeHorizontalPosition.
Inside	Not in use.
Outside	Not in use.

Remarks

The shape can be positioned horizontally relative to the area specified by the Shape.RelativeHorizontalPosition. If the alignment is set to ShapeHorizontalAlignment.None, the shape is positioned at a distance explicitly specified in the Shape.Offset property.

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 HorizontalAlignment 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#

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

        DocumentImageSource.FromStream(s));
    myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;
}

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

    System.Drawing.Image.FromFile("beverages.png"));
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;
#endregion #AddFloatingPicture

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

    System.Drawing.Image.FromFile("Documents\\beverages.png"));
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;
#endregion #AddFloatingPicture

text-boxes-simple-example-t481625/CS/TextBoxes/Form1.cs#L76

//Set the horizontal alignment
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center;
myTextBox.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Margin;

VB.NET

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

    Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), DocumentImageSource.FromStream(s))
    myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center
End Using

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

            Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("beverages.png"))
            myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center
'            #End Region ' #AddFloatingPicture

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

            Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("Documents\beverages.png"))
            myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center
'            #End Region ' #AddFloatingPicture

text-boxes-simple-example-t481625/VB/TextBoxes/Form1.vb#L70

'Set the horizontal alignment
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center
myTextBox.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Margin