Portion

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.slides.IPortion, com.aspose.slides.IDOMObject

public class Portion implements IPortion, IDOMObject

Represents a portion of text inside a text paragraph.

Constructors

Constructor	Description
Portion()	Initializes a new instance of the Portion class.
Portion(String str)	Initializes a new instance of the Portion class.
Portion(Portion portion)	Initializes a new instance of the Portion class.

Methods

Method	Description
getPortionFormat()	Returns oformatting bject which contains explicitly set formatting properties of the text portion with no inheritance applied.
getText()	Gets or sets the plain text of a portion.
setText(String value)	Gets or sets the plain text of a portion.
getField()	Returns a field of this portion.
addField(IFieldType fieldType)	Converts this portion to the automaticaly updated field.
addField(String internalString)	Converts this portion to the automaticaly updated field.
removeField()	Converts this field portion to the simple portion.
getRect()	Get coordinates of rect that bounds portion.
getCoordinates()	Get coordinates of the beginning of the portion.
getSlide()	Returns the parent slide of a text.
getPresentation()	Returns the parent presentation of a text.
getParent_Immediate()

Portion()

public Portion()

Initializes a new instance of the Portion class.

Portion(String str)

public Portion(String str)

Initializes a new instance of the Portion class.

Parameters:

Parameter	Type	Description
str	java.lang.String

Portion(Portion portion)

public Portion(Portion portion)

Initializes a new instance of the Portion class.

Parameters:

Parameter	Type	Description
portion	Portion

getPortionFormat()

public final IPortionFormat getPortionFormat()

Returns oformatting bject which contains explicitly set formatting properties of the text portion with no inheritance applied. Read-only IPortionFormat.

---

The formatting object contains the formatting parameters defined for the current portion only, inherited data is not applied.

In order to get the effective values including inherited ones use the PortionFormat.getEffective method.

Returns: IPortionFormat

getText()

public final String getText()

Gets or sets the plain text of a portion. Read/write String.

Value: The text.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Gets or sets the plain text of a portion. Read/write String.

Value: The text.

Parameters:

Parameter	Type	Description
value	java.lang.String

getField()

public final IField getField()

Returns a field of this portion. Read-only IField.

Returns: IField

addField(IFieldType fieldType)

public final void addField(IFieldType fieldType)

Converts this portion to the automaticaly updated field.

Parameters:

Parameter	Type	Description
fieldType	IFieldType

addField(String internalString)

public final void addField(String internalString)

Converts this portion to the automaticaly updated field.

Parameters:

Parameter	Type	Description
internalString	java.lang.String	Internal name of FieldType.

removeField()

public final void removeField()

Converts this field portion to the simple portion.

getRect()

public final Rectangle2D.Float getRect()

Get coordinates of rect that bounds portion. The rect includes all the lines of text in portion, including empty ones.

---

Example:
 
 Presentation pres = new Presentation();
 try
 {
 	ISlide slide = pres.getSlides().get_Item(0);
 	IAutoShape shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 200, 50);
 	shape.getTextFrame().getParagraphs().get_Item(0).getPortions().clear();
 	Portion portion0 = new Portion("Some text");
 	Portion portion1 = new Portion("GetRect text");
 	shape.getTextFrame().getParagraphs().get_Item(0).getPortions().add(portion0);
 	shape.getTextFrame().getParagraphs().get_Item(0).getPortions().add(portion1);
 	Rectangle2D.Float rect = shape.getTextFrame().getParagraphs().get_Item(0).getPortions().get_Item(1).getRect();
 	...
 } finally {
 	if (pres != null) pres.dispose();
 }

Returns: java.awt.geom.Rectangle2D.Float

getCoordinates()

public final Point2D.Float getCoordinates()

Get coordinates of the beginning of the portion. The X coordinate of point represents the portion beginning from the first character including left side bearing. The Y coordinate includes top side bearing.

Returns: java.awt.geom.Point2D.Float

getSlide()

public final IBaseSlide getSlide()

Returns the parent slide of a text. Read-only BaseSlide.

Returns: IBaseSlide

getPresentation()

public final IPresentation getPresentation()

Returns the parent presentation of a text. Read-only IPresentation.

Returns: IPresentation

getParent_Immediate()

public final IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.

Returns: com.aspose.slides.IDOMObject