java.lang.Objectcom.aspose.words.FrameFormat
public class FrameFormat
This object is always created. If a paragraph is a frame, then all properties will contain respective values, otherwise
all properties are set to their defaults. Use Example:
Document doc = new Document(getMyDir() + "Paragraph frame.docx");
Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame());
Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth());
Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight());
Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule());
Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment());
Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment());
Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition());
Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition());
Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText());
Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition());
Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition());
Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
Property Getters/Setters Summary | ||
---|---|---|
double | getHeight() | |
Gets the height of the specified frame. | ||
int | getHeightRule() | |
Gets the rule for determining the height of the specified frame. The value of the property is HeightRule integer constant. | ||
int | getHorizontalAlignment() | |
Gets horizontal alignment of the specified frame. The value of the property is HorizontalAlignment integer constant. | ||
double | getHorizontalDistanceFromText() | |
Gets horizontal distance between a frame and the surrounding text, in points. | ||
double | getHorizontalPosition() | |
Gets horizontal distance between the edge of the frame and the item specified by the |
||
boolean | isFrame() | |
Returns true if the paragraph is a frame. | ||
int | getRelativeHorizontalPosition() | |
Gets the relative horizontal position of a frame. The value of the property is RelativeHorizontalPosition integer constant. | ||
int | getRelativeVerticalPosition() | |
Gets the relative vertical position of a frame. The value of the property is RelativeVerticalPosition integer constant. | ||
int | getVerticalAlignment() | |
Gets vertical alignment of the specified frame. The value of the property is VerticalAlignment integer constant. | ||
double | getVerticalDistanceFromText() | |
Specifies vertical distance (in points) between a frame and the surrounding text. | ||
double | getVerticalPosition() | |
Gets vertical distance between the edge of the frame and the item specified by the |
||
double | getWidth() | |
Gets the width of the specified frame, in points. |
Property Getters/Setters Detail |
---|
getHeight | |
public double getHeight() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getHeightRule | |
public int getHeightRule() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getHorizontalAlignment | |
public int getHorizontalAlignment() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getHorizontalDistanceFromText | |
public double getHorizontalDistanceFromText() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getHorizontalPosition | |
public double getHorizontalPosition() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
isFrame | |
public boolean isFrame() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getRelativeHorizontalPosition | |
public int getRelativeHorizontalPosition() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getRelativeVerticalPosition | |
public int getRelativeVerticalPosition() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getVerticalAlignment | |
public int getVerticalAlignment() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getVerticalDistanceFromText | |
public double getVerticalDistanceFromText() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getVerticalPosition | |
public double getVerticalPosition() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());
getWidth | |
public double getWidth() |
Example:
Shows how to get information about formatting properties of paragraphs that are frames.Document doc = new Document(getMyDir() + "Paragraph frame.docx"); Paragraph paragraphFrame = IterableUtils.find(doc.getFirstSection().getBody().getParagraphs(), p -> p.getFrameFormat().isFrame()); Assert.assertEquals(233.3d, paragraphFrame.getFrameFormat().getWidth()); Assert.assertEquals(138.8d, paragraphFrame.getFrameFormat().getHeight()); Assert.assertEquals(HeightRule.AT_LEAST, paragraphFrame.getFrameFormat().getHeightRule()); Assert.assertEquals(HorizontalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getHorizontalAlignment()); Assert.assertEquals(VerticalAlignment.DEFAULT, paragraphFrame.getFrameFormat().getVerticalAlignment()); Assert.assertEquals(34.05d, paragraphFrame.getFrameFormat().getHorizontalPosition()); Assert.assertEquals(RelativeHorizontalPosition.PAGE, paragraphFrame.getFrameFormat().getRelativeHorizontalPosition()); Assert.assertEquals(9.0d, paragraphFrame.getFrameFormat().getHorizontalDistanceFromText()); Assert.assertEquals(20.5d, paragraphFrame.getFrameFormat().getVerticalPosition()); Assert.assertEquals(RelativeVerticalPosition.PARAGRAPH, paragraphFrame.getFrameFormat().getRelativeVerticalPosition()); Assert.assertEquals(0.0d, paragraphFrame.getFrameFormat().getVerticalDistanceFromText());