com.aspose.words

Class RelativeVerticalSize

java.lang.Object

com.aspose.words.RelativeVerticalSize

public class RelativeVerticalSize
extends java.lang.Object

Specifies relatively to what the height of a shape or a text frame is calculated vertically.

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.getRelativeVerticalSize(), ShapeBase.setRelativeVerticalSize(int)

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM_MARGIN Specifies that the height is calculated relatively to the bottom margin area size.
static int	DEFAULT Default value is MARGIN.
static int	INNER_MARGIN Specifies that the height is calculated relatively to the inside margin area size, to the top margin area size for odd pages and to the bottom margin area size for even pages.
static int	length
static int	MARGIN Specifies that the height is calculated relatively to the space between the top and the bottom margins.
static int	OUTER_MARGIN Specifies that the height is calculated relatively to the outside margin area size, to the bottom margin area size for odd pages and to the top margin area size for even pages.
static int	PAGE Specifies that the height is calculated relatively to the page height.
static int	TOP_MARGIN Specifies that the height is calculated relatively to the top margin area size.

Method Summary

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

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 height is calculated relatively to the space between the top and the bottom margins.

PAGE

public static int PAGE

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

TOP_MARGIN

public static int TOP_MARGIN

Specifies that the height is calculated relatively to the top margin area size.

BOTTOM_MARGIN

public static int BOTTOM_MARGIN

Specifies that the height is calculated relatively to the bottom margin area size.

INNER_MARGIN

public static int INNER_MARGIN

Specifies that the height is calculated relatively to the inside margin area size, to the top margin area size for odd pages and to the bottom margin area size for even pages.

OUTER_MARGIN

public static int OUTER_MARGIN

Specifies that the height is calculated relatively to the outside margin area size, to the bottom margin area size for odd pages and to the top 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 relativeVerticalSize)

toString

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

fromName

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

getValues

public static int[] getValues()