public interface IPortion extends ISlideComponent
Represents a portion of text inside a text paragraph.
Modifier and Type | Method and Description |
---|---|
void |
addField(IFieldType fieldType)
Converts this portion to the automaticaly updated field.
|
void |
addField(java.lang.String internalString)
Converts this portion to the automaticaly updated field.
|
IPortionFormatEffectiveData |
createPortionFormatEffective()
Deprecated.
Use IPortion.PortionFormat.GetEffective() instead. The method will be removed after release of version 20.8.
|
java.awt.geom.Point2D.Float |
getCoordinates()
Get coordinates of the beginning of the portion.
|
IField |
getField()
Returns a field of this portion.
|
IPortionFormat |
getPortionFormat()
Returns formatting object which contains explicitly set formatting properties of the text portion with no inheritance applied.
|
java.awt.geom.Rectangle2D.Float |
getRect()
Get coordinates of rect that bounds portion.
|
java.lang.String |
getText()
Gets or sets the plain text of a portion.
|
void |
removeField()
Converts this field portion to the simple portion.
|
void |
setText(java.lang.String value)
Gets or sets the plain text of a portion.
|
getSlide
getPresentation
IPortionFormat getPortionFormat()
Returns formatting object 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 IPortionFormat.getEffective()
method.
@Deprecated IPortionFormatEffectiveData createPortionFormatEffective()
Creates and returns IPortionFormatEffectiveData
object which contains current portion formatting properties, including inherited.
IPortionFormatEffectiveData
instance.java.lang.String getText()
Gets or sets the plain text of a portion.
Read/write String
.
void setText(java.lang.String value)
Gets or sets the plain text of a portion.
Read/write String
.
void addField(IFieldType fieldType)
Converts this portion to the automaticaly updated field.
void addField(java.lang.String internalString)
Converts this portion to the automaticaly updated field.
internalString
- Internal name of FieldTypeEx.void removeField()
Converts this field portion to the simple portion.
java.awt.geom.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(); }
java.awt.geom.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.