com.aspose.words
Class RelativeHorizontalPosition

java.lang.Object
    extended by com.aspose.words.RelativeHorizontalPosition

public class RelativeHorizontalPosition 
extends java.lang.Object

Utility class containing constants. Specifies to what the horizontal position of a shape or text frame is relative.

Example:

Shows how to insert a floating image in the middle of a page.
// This creates a builder and also an empty document inside the builder.
DocumentBuilder builder = new DocumentBuilder();

// By default, the image is inline.
Shape shape = builder.insertImage(getMyDir() + "Aspose.Words.gif");

// Make the image float, put it behind text and center on the page.
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setHorizontalAlignment(HorizontalAlignment.CENTER);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setVerticalAlignment(VerticalAlignment.CENTER);

builder.getDocument().save(getMyDir() + "Image.CreateFloatingPageCenter Out.doc");

Example:

Inserts a watermark image into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// The best place for the watermark image is in the header or footer so it is shown on every page.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);

// Insert a floating picture.
BufferedImage image =
        javax.imageio.ImageIO.read(new File(getMyDir() + "Watermark.png"));

Shape shape = builder.insertImage(image);
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);

shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);

// Calculate image left and top position so it appears in the centre of the page.
shape.setLeft((builder.getPageSetup().getPageWidth() - shape.getWidth()) / 2);
shape.setTop((builder.getPageSetup().getPageHeight() - shape.getHeight()) / 2);

doc.save(getMyDir() + "DocumentBuilder.InsertWatermark Out.doc");
See Also:
ShapeBase.RelativeHorizontalPosition

Field Summary
static final intMARGIN
           Specifies that the horizontal positioning shall be relative to the page margins.
static final intPAGE
           The object is positioned relative to the left edge of the page.
static final intCOLUMN
           The object is positioned relative to the left side of the column.
static final intCHARACTER
           The object is positioned relative to the left side of the paragraph.
static final intINSIDE_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 final intOUTSIDE_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 final intLEFT_MARGIN
           Specifies that the horizontal positioning shall be relative to the left margin of the page.
static final intRIGHT_MARGIN
           Specifies that the horizontal positioning shall be relative to the right margin of the page.
static final intDEFAULT
           Default value is COLUMN.
 

Field Detail

MARGIN

public static final int MARGIN
Specifies that the horizontal positioning shall be relative to the page margins.

PAGE

public static final int PAGE
The object is positioned relative to the left edge of the page.

COLUMN

public static final int COLUMN
The object is positioned relative to the left side of the column.

CHARACTER

public static final int CHARACTER
The object is positioned relative to the left side of the paragraph.

INSIDE_MARGIN

public static final 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 final 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).

LEFT_MARGIN

public static final int LEFT_MARGIN
Specifies that the horizontal positioning shall be relative to the left margin of the page.

RIGHT_MARGIN

public static final int RIGHT_MARGIN
Specifies that the horizontal positioning shall be relative to the right margin of the page.

DEFAULT

public static final int DEFAULT
Default value is COLUMN.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.