com.spire.doc.pages
Class LayoutElement

java.lang.Object
  com.spire.doc.pages.LayoutElement

Direct Known Subclasses:

BodyLayoutElement, FixedLayoutDocument, FixedLayoutLine, FixedLayoutPage, FixedLayoutRow, FixedLayoutSpan

public abstract class LayoutElement
extends java.lang.Object

The class serves as the foundation for elements in a document that have been rendered.

Constructor Summary

LayoutElement()

Method Summary

LayoutCollection<LayoutElement>	getChildEntities(LayoutElementType type, boolean isDeep) Obtains a group of child entities that are of a specific type.
int	getPageIndex() Gets the index of a page in which rendered object.
LayoutElement	getParent() Gets the parent of this entity.
DocumentObject	getParentNode() Provides the layout node that pertains to this particular entity.
com.spire.ms.System.Drawing.RectangleF	getRectangle() Returns bounding rectangle of the entity relative to the page top left corner (in points).
java.lang.String	getText() Outputs the entity's contents as a plain text string.
LayoutElementType	getType() Gets the type of this layout entity.

Constructor Detail

LayoutElement

public LayoutElement()

Method Detail

getPageIndex

public int getPageIndex()

Gets the index of a page in which rendered object. starting from 1.

getRectangle

public com.spire.ms.System.Drawing.RectangleF getRectangle()

Returns bounding rectangle of the entity relative to the page top left corner (in points).

getType

public LayoutElementType getType()

Gets the type of this layout entity.

getText

public java.lang.String getText()

Outputs the entity's contents as a plain text string.

getParent

public LayoutElement getParent()

Gets the parent of this entity.

getParentNode

public DocumentObject getParentNode()

Provides the layout node that pertains to this particular entity. This property may return null for spans that originate from Run nodes or nodes inside the header or footer.

getChildEntities

public LayoutCollection<LayoutElement> getChildEntities(LayoutElementType type,
                                                        boolean isDeep)

Obtains a group of child entities that are of a specific type.

Parameters:

type - Specifies the type of entities to select.

isDeep - True to select from all child entities recursively.

Returns: