Overview
PictureFrame is a class in Aspose.Slides FOSS for Java.
Inherits from: GeometryShape, IPictureFrame.
Represents a frame with a picture inside.
This class provides 55 methods for working with PictureFrame objects in Java programs.
Available methods include: GeometryShape, PictureFrame, asIPresentationComponent, getAdjustments, getAlternativeText, getAlternativeTextTitle, getAsISlideComponent, getCNvPr, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, and 43 additional methods.
All exported members are accessible to any Java application after installing the Aspose.Slides FOSS for Java package.
Properties: adjustments, alternativeText, alternativeTextTitle, asISlideComponent, cNvPr, cameo, and 30 more.
Properties
| Name | Type | Access | Description |
|---|
shapeType | ShapeType | Read | {@inheritDoc} |
Returns or sets the AutoShape type for a PictureFrame. |
| `pictureFrameLock` | `IPictureFrameLock` | Read | {@inheritDoc}
Navigates {@code //} and creates
the {@code } element if it does not exist.
/ |
| `pictureFormat` | `IPictureFillFormat` | Read | {@inheritDoc}
Returns the {@link PictureFillFormat} wrapping the {@code }
child element, or {@code null} if no blipFill is present.
/ |
| `relativeScaleHeight` | `double` | Read | Gets the relative scale height. |
| `relativeScaleWidth` | `double` | Read | Gets the relative scale width. |
| `cameo` | `boolean` | Read | Gets the cameo. |
| `cNvPr` | `Element` | Read | Returns the {@code cNvPr} element from {@code
/}. |
| `x` | `double` | Read | Gets the x. |
| `y` | `double` | Read | Gets the y. |
| `width` | `double` | Read | Gets the width. |
| `height` | `double` | Read | Gets the height. |
| `rotation` | `double` | Read | Gets the rotation. |
| `shapeStyle` | `IShapeStyle` | Read | Gets the shape style. |
| `fillFormat` | `IFillFormat` | Read | Gets the fill format. |
| `adjustments` | `IAdjustValueCollection` | Read | Gets the adjustments. |
| `textHolder` | `boolean` | Read | Gets the text holder. |
| `placeholder` | `IPlaceholder` | Read | Gets the placeholder. |
| `customData` | `ICustomData` | Read | Gets the custom data. |
| `rawFrame` | `IShapeFrame` | Read | Gets the raw frame. |
| `frame` | `IShapeFrame` | Read | Gets the frame. |
| `lineFormat` | `ILineFormat` | Read | Gets the line format. |
| `threeDFormat` | `IThreeDFormat` | Read | Gets the three d format. |
| `effectFormat` | `IEffectFormat` | Read | Gets the effect format. |
| `hidden` | `boolean` | Read | Gets the hidden. |
| `zOrderPosition` | `int` | Read | Gets the z order position. |
| `connectionSiteCount` | `int` | Read | Gets the connection site count. |
| `alternativeText` | `String` | Read | Gets the alternative text. |
| `alternativeTextTitle` | `String` | Read | Gets the alternative text title. |
| `name` | `String` | Read | Gets the name. |
| `decorative` | `boolean` | Read | Gets the decorative. |
| `uniqueId` | `int` | Read | Gets the unique id. |
| `officeInteropShapeId` | `int` | Read | Gets the office interop shape id. |
| `grouped` | `boolean` | Read | Gets the grouped. |
| `asISlideComponent` | `ISlideComponent` | Read | Gets the as i slide component. |
| `slide` | `IBaseSlide` | Read | Gets the slide. |
| `presentation` | `IPresentation` | Read | Gets the presentation. |Methods
| Signature | Description |
|---|
PictureFrame(xmlElement: Element, saveCallback: Runnable) | Creates a PictureFrame backed by the given XML element. |
PictureFrame() | Creates a PictureFrame with no backing element. |
getShapeType() → ShapeType | {@inheritDoc} |
Returns or sets the AutoShape type for a PictureFrame. |
| `setShapeType(value: ShapeType)` | {@inheritDoc}
/ |
| `getPictureFrameLock()` → `IPictureFrameLock` | {@inheritDoc}
Navigates {@code //} and creates
the {@code } element if it does not exist.
/ |
| `getPictureFormat()` → `IPictureFillFormat` | {@inheritDoc}Returns the {@link PictureFillFormat} wrapping the {@code }
child element, or {@code null} if no blipFill is present.
/ |
| `getRelativeScaleHeight()` → `double` | Returns the relative scale height. |
| `setRelativeScaleHeight(value: double)` | Sets the relative scale height value. |
| `getRelativeScaleWidth()` → `double` | Returns the relative scale width. |
| `setRelativeScaleWidth(value: double)` | Sets the relative scale width value. |
| `isCameo()` → `boolean` | Returns true if cameo is set. |
| `getCNvPr()` → `Element` | Returns the {@code cNvPr} element from {@code /}. |
| `GeometryShape(xmlElement: Element, saveCallback: Runnable)` | Creates a GeometryShape backed by the given XML element. |
| `setParentShapes(shapes: Iterable)` | Sets the sibling shapes collection used for connection lookups. |
| `getX()` → `double` | Returns the x. |
| `setX(x: double)` | Sets the x value. |
| `getY()` → `double` | Returns the y. |
| `setY(y: double)` | Sets the y value. |
| `getWidth()` → `double` | Returns the width. |
| `setWidth(width: double)` | Sets the width value. |
| `getHeight()` → `double` | Returns the height. |
| `setHeight(height: double)` | Sets the height value. |
| `getRotation()` → `double` | Returns the rotation. |
| `setRotation(rotation: double)` | Sets the rotation value. |
| `getShapeStyle()` → `IShapeStyle` | Returns the shape style. |
| `getFillFormat()` → `IFillFormat` | Returns the fill format. |
| `getAdjustments()` → `IAdjustValueCollection` | Returns the adjustments. |
| `isTextHolder()` → `boolean` | Returns true if text holder is set. |
| `getPlaceholder()` → `IPlaceholder` | Returns the placeholder. |
| `getCustomData()` → `ICustomData` | Returns the custom data. |
| `getRawFrame()` → `IShapeFrame` | Returns the raw frame. |
| `setRawFrame(value: IShapeFrame)` | Sets the raw frame value. |
| `getFrame()` → `IShapeFrame` | Returns the frame. |
| `setFrame(value: IShapeFrame)` | Sets the frame value. |
| `getLineFormat()` → `ILineFormat` | Returns the line format. |
| `getThreeDFormat()` → `IThreeDFormat` | Returns the three d format. |
| `getEffectFormat()` → `IEffectFormat` | Returns the effect format. |
| `isHidden()` → `boolean` | Returns true if hidden is set. |
| `setHidden(value: boolean)` | Sets the hidden value. |
| `getZOrderPosition()` → `int` | Returns the z order position. |
| `getConnectionSiteCount()` → `int` | Returns the connection site count. |
| `getAlternativeText()` → `String` | Returns the alternative text. |
| `setAlternativeText(value: String)` | Sets the alternative text value. |
| `getAlternativeTextTitle()` → `String` | Returns the alternative text title. |
| `setAlternativeTextTitle(value: String)` | Sets the alternative text title value. |
| `getName()` → `String` | Returns the name. |
| `setName(value: String)` | Sets the name value. |
| `isDecorative()` → `boolean` | Returns true if decorative is set. |
| `setDecorative(value: boolean)` | Sets the decorative value. |
| `getUniqueId()` → `int` | Returns the unique id. |
| `getOfficeInteropShapeId()` → `int` | Returns the office interop shape id. |
| `isGrouped()` → `boolean` | Returns true if grouped is set. |
| `getAsISlideComponent()` → `ISlideComponent` | Returns the as i slide component. |
| `getSlide()` → `IBaseSlide` | Returns the slide. |
| `getPresentation()` → `IPresentation` | Returns the presentation. |
| `asIPresentationComponent()` → `IPresentationComponent` | |See Also