com.aspose.words

Class RelativeHorizontalPosition

java.lang.Object

com.aspose.words.RelativeHorizontalPosition

public class RelativeHorizontalPosition
extends java.lang.Object

Specifies to what the horizontal 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.getRelativeHorizontalPosition(), ShapeBase.setRelativeHorizontalPosition(int)

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHARACTER The object is positioned relative to the left side of the paragraph.
static int	COLUMN The object is positioned relative to the left side of the column.
static int	DEFAULT Default value is COLUMN.
static int	INSIDE_MARGIN Specifies that the horizontal positioning shall be relative to the inside margin of the current page (the left margin on odd pages, right on even pages).
static int	LEFT_MARGIN Specifies that the horizontal positioning shall be relative to the left margin of the page.
static int	length
static int	MARGIN Specifies that the horizontal positioning shall be relative to the page margins.
static int	OUTSIDE_MARGIN Specifies that the horizontal positioning shall be relative to the outside margin of the current page (the right margin on odd pages, left on even pages).
static int	PAGE The object is positioned relative to the left edge of the page.
static int	RIGHT_MARGIN Specifies that the horizontal positioning shall be relative to the right margin of the page.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String relativeHorizontalPositionName)
static java.lang.String	getName(int relativeHorizontalPosition)
static int[]	getValues()
static java.lang.String	toString(int relativeHorizontalPosition)

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 horizontal positioning shall be relative to the page margins.

PAGE

public static int PAGE

The object is positioned relative to the left edge of the page.

COLUMN

public static int COLUMN

The object is positioned relative to the left side of the column.

CHARACTER

public static int CHARACTER

The object is positioned relative to the left side of the paragraph.

LEFT_MARGIN

public static int LEFT_MARGIN

Specifies that the horizontal positioning shall be relative to the left margin of the page.

RIGHT_MARGIN

public static int RIGHT_MARGIN

Specifies that the horizontal positioning shall be relative to the right margin of the page.

INSIDE_MARGIN

public static int INSIDE_MARGIN

Specifies that the horizontal positioning shall be relative to the inside margin of the current page (the left margin on odd pages, right on even pages).

OUTSIDE_MARGIN

public static int OUTSIDE_MARGIN

Specifies that the horizontal positioning shall be relative to the outside margin of the current page (the right margin on odd pages, left on even pages).

DEFAULT

public static int DEFAULT

Default value is COLUMN.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int relativeHorizontalPosition)

toString

public static java.lang.String toString(int relativeHorizontalPosition)

fromName

public static int fromName(java.lang.String relativeHorizontalPositionName)

getValues

public static int[] getValues()