com.aspose.words

Class RelativeHorizontalSize

java.lang.Object

com.aspose.words.RelativeHorizontalSize

public class RelativeHorizontalSize
extends java.lang.Object

Specifies relatively to what the width of a shape or a text frame is calculated horizontally.

Examples:

Shows how to set relative size and position.

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

 // Adding a simple shape with absolute size and position.
 Shape shape = builder.insertShape(ShapeType.RECTANGLE, 100.0, 40.0);
 // Set WrapType to WrapType.None since Inline shapes are automatically converted to absolute units.
 shape.setWrapType(WrapType.NONE);

 // Checking and setting the relative horizontal size.
 if (shape.getRelativeHorizontalSize() == RelativeHorizontalSize.DEFAULT)
 {
     // Setting the horizontal size binding to Margin.
     shape.setRelativeHorizontalSize(RelativeHorizontalSize.MARGIN);
     // Setting the width to 50% of Margin width.
     shape.setWidthRelative(50f);
 }

 // Checking and setting the relative vertical size.
 if (shape.getRelativeVerticalSize() == RelativeVerticalSize.DEFAULT)
 {
     // Setting the vertical size binding to Margin.
     shape.setRelativeVerticalSize(RelativeVerticalSize.MARGIN);
     // Setting the heigh to 30% of Margin height.
     shape.setHeightRelative(30f);
 }

 // Checking and setting the relative vertical position.
 if (shape.getRelativeVerticalPosition() == RelativeVerticalPosition.PARAGRAPH)
 {
     // etting the position binding to TopMargin.
     shape.setRelativeVerticalPosition(RelativeVerticalPosition.TOP_MARGIN);
     // Setting relative Top to 30% of TopMargin position.
     shape.setTopRelative(30f);
 }

 // Checking and setting the relative horizontal position.
 if (shape.getRelativeHorizontalPosition() == RelativeHorizontalPosition.DEFAULT)
 {
     // Setting the position binding to RightMargin.
     shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.RIGHT_MARGIN);
     // The position relative value can be negative.
     shape.setLeftRelative(-260);
 }

 doc.save(getArtifactsDir() + "Shape.RelativeSizeAndPosition.docx");
 
 

See Also:

ShapeBase.getRelativeHorizontalSize(), ShapeBase.setRelativeHorizontalSize(int)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT Default value is MARGIN.
static int	INNER_MARGIN Specifies that the width is calculated relatively to the inside margin area size, to the left margin area size for odd pages and to the right margin area size for even pages.
static int	LEFT_MARGIN Specifies that the width is calculated relatively to the left margin area size.
static int	length
static int	MARGIN Specifies that the width is calculated relatively to the space between the left and the right margins.
static int	OUTER_MARGIN Specifies that the width is calculated relatively to the outside margin area size, to the right margin area size for odd pages and to the left margin area size for even pages.
static int	PAGE Specifies that the width is calculated relatively to the page width.
static int	RIGHT_MARGIN Specifies that the width is calculated relatively to the right margin area size.

Method Summary

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

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 width is calculated relatively to the space between the left and the right margins.

PAGE

public static int PAGE

Specifies that the width is calculated relatively to the page width.

LEFT_MARGIN

public static int LEFT_MARGIN

Specifies that the width is calculated relatively to the left margin area size.

RIGHT_MARGIN

public static int RIGHT_MARGIN

Specifies that the width is calculated relatively to the right margin area size.

INNER_MARGIN

public static int INNER_MARGIN

Specifies that the width is calculated relatively to the inside margin area size, to the left margin area size for odd pages and to the right margin area size for even pages.

OUTER_MARGIN

public static int OUTER_MARGIN

Specifies that the width is calculated relatively to the outside margin area size, to the right margin area size for odd pages and to the left margin area size for even pages.

DEFAULT

public static int DEFAULT

Default value is MARGIN.

length

public static int length

Method Detail

getName

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

toString

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

fromName

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

getValues

public static int[] getValues()