Back to Devexpress

Table.VerticalAlignment Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-table-67f834cb.md

latest10.2 KB
Original Source

Table.VerticalAlignment Property

Gets or sets the table’s vertical alignment.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
TableVerticalAlignment VerticalAlignment { get; set; }
vb
Property VerticalAlignment As TableVerticalAlignment

Property Value

TypeDescription
TableVerticalAlignment

An enumeration value that indicates the table’s vertical alignment.

|

Available values:

NameDescription
None

The Table.OffsetYRelative property specifies the exact position.

| | Top |

The table is top aligned relative to its Table.RelativeVerticalPosition.

| | Center |

The table is centered relative to its Table.RelativeVerticalPosition.

| | Bottom |

The table is aligned to the bottom relative to its Table.RelativeVerticalPosition.

| | Inside |

The table is inside relative to its Table.RelativeVerticalPosition.

| | Outside |

The table is outside relative to its Table.RelativeVerticalPosition.

|

Remarks

This property is in effect for tables with Table.TextWrappingType set to TableTextWrappingType.Around.

The VerticalAlignment property defines the alignment relative to the element specified in Table.RelativeVerticalPosition property. If the VerticalAlignment property is set to None, the Table.OffsetYRelative property specifies the table’s position.

The VerticalAlignment property value is ignored when the Table.RelativeVerticalPosition property is set to Paragraph. Use the Table.OffsetYRelative property instead.

Note

The TableVerticalAlignment.Inside and TableVerticalAlignment.Outside values are ignored when the document is opened in the RichEditControl. However, you can set this property in code and save its value to a file for further processing in Microsoft Word or other word processing applications.

The code sample below shows how to specify the table’s vertical alignment:

csharp
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using DevExpress.Office.Utils;

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
  Document document = wordProcessor.Document;
  Table table = document.Tables[0];
  table.BeginUpdate();
  //Wrap text around the table
  table.TextWrappingType = TableTextWrappingType.Around;

  //Specify vertical alignment:
  table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
  table.VerticalAlignment = TableVerticalAlignment.None;
  table.OffsetYRelative = Units.InchesToDocumentsF(2f);
  table.EndUpdate();
}
vb
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.Office.Utils

Using wordProcessor As New RichEditDocumentServer()
  Dim document As Document = wordProcessor.Document
  Dim table As Table = document.Tables(0)
  table.BeginUpdate()
  'Wrap text around the table
  table.TextWrappingType = TableTextWrappingType.Around

  'Specify vertical alignment:
  table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
  table.VerticalAlignment = TableVerticalAlignment.None
  table.OffsetYRelative = Units.InchesToDocumentsF(2F)
  table.EndUpdate()
End Using

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

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Table.cs#L273

csharp
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;
table.OffsetYRelative = DevExpress.Office.Utils.Units.InchesToDocumentsF(2f);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/TableActions.cs#L276

csharp
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;
table.OffsetYRelative = DevExpress.Office.Utils.Units.InchesToDocumentsF(2f);

winforms-richedit-tables-simple-example/CS/TablesSimpleExample/Form1.cs#L87

csharp
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;
table.OffsetYRelative = Units.InchesToDocumentsF(2f);

word-document-api-examples/CS/CodeExamples/TablesActions.cs#L386

csharp
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;
table.OffsetYRelative = DevExpress.Office.Utils.Units.InchesToDocumentsF(2f);

word-document-api-table-examples/CS/Program.cs#L222

csharp
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;
table.OffsetYRelative = Units.InchesToDocumentsF(2f);

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Table.vb#L245

vb
table.RelativeVerticalPosition = DevExpress.XtraRichEdit.API.Native.TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = DevExpress.XtraRichEdit.API.Native.TableVerticalAlignment.None
table.OffsetYRelative = DevExpress.Office.Utils.Units.InchesToDocumentsF(2F)

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/TableActions.vb#L245

vb
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = TableVerticalAlignment.None
table.OffsetYRelative = DevExpress.Office.Utils.Units.InchesToDocumentsF(2F)

winforms-richedit-tables-simple-example/VB/TablesSimpleExample/Form1.vb#L71

vb
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = TableVerticalAlignment.None
table.OffsetYRelative = Units.InchesToDocumentsF(2F)

word-document-api-examples/VB/CodeExamples/TablesActions.vb#L327

vb
table.RelativeVerticalPosition = DevExpress.XtraRichEdit.API.Native.TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = DevExpress.XtraRichEdit.API.Native.TableVerticalAlignment.None
table.OffsetYRelative = DevExpress.Office.Utils.Units.InchesToDocumentsF(2.0F)

word-document-api-table-examples/VB/Program.vb#L179

vb
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = TableVerticalAlignment.None
table.OffsetYRelative = Units.InchesToDocumentsF(2F)

See Also

Table Interface

Table Members

DevExpress.XtraRichEdit.API.Native Namespace