RelativeVerticalPosition (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.RelativeVerticalPosition

public class RelativeVerticalPosition
extends java.lang.Object

Specifies to what the vertical position of a shape or text frame is relative.

Examples:

Shows how to insert a floating image to the center of a page.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a floating image that will appear behind the overlapping text and align it to the page's center.
 Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
 shape.setWrapType(WrapType.NONE);
 shape.setBehindText(true);
 shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
 shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
 shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
 shape.setVerticalAlignment(VerticalAlignment.CENTER);

 doc.save(getArtifactsDir() + "Image.CreateFloatingPageCenter.docx");

Shows how to insert an image, and use it as a watermark.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert the image into the header so that it will be visible on every page.
 builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
 Shape shape = builder.insertImage(getImageDir() + "Transparent background logo.png");
 shape.setWrapType(WrapType.NONE);
 shape.setBehindText(true);

 // Place the image at the center of the page.
 shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
 shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
 shape.setLeft((builder.getPageSetup().getPageWidth() - shape.getWidth()) / 2.0);
 shape.setTop((builder.getPageSetup().getPageHeight() - shape.getHeight()) / 2.0);

 doc.save(getArtifactsDir() + "DocumentBuilder.InsertWatermark.docx");

See Also:: ShapeBase.getRelativeVerticalPosition(), ShapeBase.setRelativeVerticalPosition(int)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM_MARGIN` Specifies that the vertical positioning shall be relative to the bottom margin of the current page.
`static int`	`INSIDE_MARGIN` Specifies that the vertical positioning shall be relative to the inside margin of the current page.
`static int`	`length`
`static int`	`LINE` Undocumented.
`static int`	`MARGIN` Specifies that the vertical positioning shall be relative to the page margins.
`static int`	`OUTSIDE_MARGIN` Specifies that the vertical positioning shall be relative to the outside margin of the current page.
`static int`	`PAGE` The object is positioned relative to the top edge of the page.
`static int`	`PARAGRAPH` The object is positioned relative to the top of the paragraph that contains the anchor.
`static int`	`TABLE_DEFAULT` Default value is `MARGIN`.
`static int`	`TEXT_FRAME_DEFAULT` Default value is `PARAGRAPH`.
`static int`	`TOP_MARGIN` Specifies that the vertical positioning shall be relative to the top margin of the current page.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`fromName(java.lang.String relativeVerticalPositionName)`
`static java.lang.String`	`getName(int relativeVerticalPosition)`
`static int[]`	`getValues()`
`static java.lang.String`	`toString(int relativeVerticalPosition)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MARGIN
```
public static int MARGIN
```
    Specifies that the vertical positioning shall be relative to the page margins.
  - PAGE
```
public static int PAGE
```
    The object is positioned relative to the top edge of the page.
  - PARAGRAPH
```
public static int PARAGRAPH
```
    The object is positioned relative to the top of the paragraph that contains the anchor.
  - LINE
```
public static int LINE
```
    Undocumented.
  - TOP_MARGIN
```
public static int TOP_MARGIN
```
    Specifies that the vertical positioning shall be relative to the top margin of the current page.
  - BOTTOM_MARGIN
```
public static int BOTTOM_MARGIN
```
    Specifies that the vertical positioning shall be relative to the bottom margin of the current page.
  - INSIDE_MARGIN
```
public static int INSIDE_MARGIN
```
    Specifies that the vertical positioning shall be relative to the inside margin of the current page.
  - OUTSIDE_MARGIN
```
public static int OUTSIDE_MARGIN
```
    Specifies that the vertical positioning shall be relative to the outside margin of the current page.
  - TABLE_DEFAULT
```
public static int TABLE_DEFAULT
```
    Default value is MARGIN.
  - TEXT_FRAME_DEFAULT
```
public static int TEXT_FRAME_DEFAULT
```
    Default value is PARAGRAPH.
  - length
```
public static int length
```
- Method Detail
  - getName
```
public static java.lang.String getName(int relativeVerticalPosition)
```
  - toString
```
public static java.lang.String toString(int relativeVerticalPosition)
```
  - fromName
```
public static int fromName(java.lang.String relativeVerticalPositionName)
```
  - getValues
```
public static int[] getValues()
```

Class RelativeVerticalPosition

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARGIN

PAGE

PARAGRAPH

LINE

TOP_MARGIN

BOTTOM_MARGIN

INSIDE_MARGIN

OUTSIDE_MARGIN

TABLE_DEFAULT

TEXT_FRAME_DEFAULT

length

Method Detail

getName

toString

fromName

getValues