FrameFormat

Overview

FrameFormat is a class in Aspose.Words FOSS for Java.

Represents frame related formatting for a paragraph.

Edition status of its 24 listed members (a property and its accessor methods are listed separately, overloads once): 24 not yet exercised by a verified example.

This class declares 12 methods for FrameFormat objects in Java programs. Available methods include: getHeight, getHeightRule, getHorizontalAlignment, getHorizontalDistanceFromText, getHorizontalPosition, getRelativeHorizontalPosition, getRelativeVerticalPosition, getVerticalAlignment, getVerticalDistanceFromText, getVerticalPosition, getWidth, isFrame. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: frame, height, heightRule, horizontalAlignment, horizontalDistanceFromText, horizontalPosition, and 6 more.

Properties

NameTypeAccessDescription
heightRuleintReadGets the rule for determining the height of the specified frame.
heightdoubleReadGets the height of the specified frame.
horizontalDistanceFromTextdoubleReadGets horizontal distance between a frame and the surrounding text, in points.
horizontalPositiondoubleReadGets horizontal distance between the edge of the frame and the item specified by the RelativeHorizontalPosition property.
relativeHorizontalPositionintReadGets the relative horizontal position of a frame.
relativeVerticalPositionintReadGets the relative vertical position of a frame.
verticalDistanceFromTextdoubleReadSpecifies vertical distance (in points) between a frame and the surrounding text.
verticalPositiondoubleReadGets vertical distance between the edge of the frame and the item specified by the RelativeVerticalPosition property.
widthdoubleReadGets the width of the specified frame, in points.
verticalAlignmentintReadGets vertical alignment of the specified frame.
horizontalAlignmentintReadGets horizontal alignment of the specified frame.
framebooleanReadReturns true if the paragraph is a frame.

Methods

SignatureDescription
getHeightRule() → intGets the rule for determining the height of the specified frame.
getHeight() → doubleGets the height of the specified frame.
getHorizontalDistanceFromText() → doubleGets horizontal distance between a frame and the surrounding text, in points.
getHorizontalPosition() → doubleGets horizontal distance between the edge of the frame and the item specified by the RelativeHorizontalPosition property.
getRelativeHorizontalPosition() → intGets the relative horizontal position of a frame.
getRelativeVerticalPosition() → intGets the relative vertical position of a frame.
getVerticalDistanceFromText() → doubleSpecifies vertical distance (in points) between a frame and the surrounding text.
getVerticalPosition() → doubleGets vertical distance between the edge of the frame and the item specified by the RelativeVerticalPosition property.
getWidth() → doubleGets the width of the specified frame, in points.
getVerticalAlignment() → intGets vertical alignment of the specified frame.
getHorizontalAlignment() → intGets horizontal alignment of the specified frame.
isFrame() → booleanReturns true if the paragraph is a frame.

See Also