Back to Devexpress

Table.RelativeVerticalPosition Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-table-0db6eb31.md

latest8.5 KB
Original Source

Table.RelativeVerticalPosition Property

Gets or sets to what the table’s vertical position is relative.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
TableRelativeVerticalPosition RelativeVerticalPosition { get; set; }
vb
Property RelativeVerticalPosition As TableRelativeVerticalPosition

Property Value

TypeDescription
TableRelativeVerticalPosition

An enumeration value that indicates the element to which the table’s vertical position is relative.

|

Available values:

NameDescription
Margin

The table position is relative to a margin.

| | Page |

The table position is relative to a page.

| | Paragraph |

The table position is relative to a paragraph.

|

Remarks

Use the RelativeVerticalPosition to specify the relative element for Table.VerticalAlignment and Table.OffsetYRelative property values.

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

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

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 RelativeVerticalPosition 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#L272

csharp
//Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;

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

csharp
//Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;

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

csharp
// Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;

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

csharp
// Specify vertical alignment.
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;

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

csharp
//Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph;
table.VerticalAlignment = TableVerticalAlignment.None;

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

vb
'Specify vertical alignment:
table.RelativeVerticalPosition = DevExpress.XtraRichEdit.API.Native.TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = DevExpress.XtraRichEdit.API.Native.TableVerticalAlignment.None

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

vb
'Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = TableVerticalAlignment.None

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

vb
' Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = TableVerticalAlignment.None

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

vb
' Specify vertical alignment.
table.RelativeVerticalPosition = DevExpress.XtraRichEdit.API.Native.TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = DevExpress.XtraRichEdit.API.Native.TableVerticalAlignment.None

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

vb
'Specify vertical alignment:
table.RelativeVerticalPosition = TableRelativeVerticalPosition.Paragraph
table.VerticalAlignment = TableVerticalAlignment.None

See Also

Table Interface

Table Members

DevExpress.XtraRichEdit.API.Native Namespace