java.lang.Object
com.aspose.words.FrameFormat
public class FrameFormat
- extends java.lang.Object
Represents frame related formatting for a paragraph.
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 IsFrame to check whether paragraph is a frame.
Property Getters/Setters Detail |
getHeight | |
public double getHeight()
|
-
Gets the height of the specified frame.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getHeightRule | |
public int getHeightRule()
|
-
Gets the rule for determining the height of the specified frame.
The value of the property is HeightRule integer constant.
getHorizontalAlignment | |
public int getHorizontalAlignment()
|
-
Gets horizontal alignment of the specified frame.
The value of the property is HorizontalAlignment integer constant.
getHorizontalDistanceFromText | |
public double getHorizontalDistanceFromText()
|
-
Gets horizontal distance between a frame and the surrounding text, in points.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getHorizontalPosition | |
public double getHorizontalPosition()
|
-
Gets horizontal distance between the edge of the frame and the item specified by the RelativeHorizontalPosition property.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
isFrame | |
public boolean isFrame()
|
-
Returns true if the paragraph is a frame.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getRelativeHorizontalPosition | |
public int getRelativeHorizontalPosition()
|
-
Gets the relative horizontal position of a frame.
The value of the property is RelativeHorizontalPosition integer constant.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getRelativeVerticalPosition | |
public int getRelativeVerticalPosition()
|
-
Gets the relative vertical position of a frame.
The value of the property is RelativeVerticalPosition integer constant.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getVerticalAlignment | |
public int getVerticalAlignment()
|
-
Gets vertical alignment of the specified frame.
The value of the property is VerticalAlignment integer constant.
getVerticalDistanceFromText | |
public double getVerticalDistanceFromText()
|
-
Specifies vertical distance (in points) between a frame and the surrounding text.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getVerticalPosition | |
public double getVerticalPosition()
|
-
Gets vertical distance between the edge of the frame and the item specified by the RelativeVerticalPosition property.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
getWidth | |
public double getWidth()
|
-
Gets the width of the specified frame, in points.
Example:
Shows how to get information about formatting properties of paragraph as frame.
Document doc = new Document(getMyDir() + "Paragraph.Frame.docx");
ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs();
for (Paragraph paragraph : (Iterable<Paragraph>) paragraphs)
{
if (paragraph.getFrameFormat().isFrame())
{
System.out.println("Width: " + paragraph.getFrameFormat().getWidth());
System.out.println("Height: " + paragraph.getFrameFormat().getHeight());
System.out.println("HorizontalPosition: " + paragraph.getFrameFormat().getHorizontalPosition());
System.out.println("RelativeHorizontalPosition: " + paragraph.getFrameFormat().getRelativeHorizontalPosition());
System.out.println("HorizontalDistanceFromText: " + paragraph.getFrameFormat().getHorizontalDistanceFromText());
System.out.println("VerticalPosition: " + paragraph.getFrameFormat().getVerticalPosition());
System.out.println("RelativeVerticalPosition: " + paragraph.getFrameFormat().getRelativeVerticalPosition());
System.out.println("VerticalDistanceFromText: " + paragraph.getFrameFormat().getVerticalDistanceFromText());
}
}
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.