java.lang.Objectcom.aspose.words.DrawingMLImageData
public class DrawingMLImageData
Use the An image can be stored inside a shape, linked to external file or both (linked and stored in the document). Regardless of whether the image is stored inside the shape or linked, you can always access the actual
image using the To store an image inside a shape use the
Property Getters/Setters Summary | ||
---|---|---|
boolean | hasImage() | |
Returns true if the shape has image bytes or links an image. | ||
byte[] | getImageBytes() | |
void | setImageBytes(byte[] value) | |
Gets or sets the raw bytes of the image stored in the shape. | ||
ImageSize | getImageSize() | |
Gets the information about image size and resolution. | ||
int | getImageType() | |
Gets the type of the image. The value of the property is ImageType integer constant. | ||
boolean | isLink() | |
Returns true if the image is linked to the DrawingML picture (when |
||
boolean | isLinkOnly() | |
Returns true if the image is linked and not stored in the document. | ||
java.lang.String | getSourceFullName() | |
void | setSourceFullName(java.lang.String value) | |
Gets or sets the path and name of the source file for the linked image. |
Method Summary | ||
---|---|---|
void | save(java.io.OutputStream stream) | |
Saves the image into the specified stream. | ||
void | save(java.lang.String fileName) | |
Saves the image into a file. | ||
void | setImage(java.awt.image.BufferedImage image) | |
Sets the image that the shape displays. | ||
void | setImage(java.io.InputStream stream) | |
Sets the image that the DrawingML picture displays. | ||
void | setImage(java.lang.String fileName) | |
Sets the image that the DrawingML picture displays. | ||
byte[] | toByteArray() | |
Returns image bytes for any image regardless whether the image is stored or linked. | ||
java.awt.image.BufferedImage | toImage() | |
Gets the image stored in the DrawingML picture as a java BufferedImage object. |
Property Getters/Setters Detail |
---|
hasImage | |
public boolean hasImage() |
getImageBytes/setImageBytes | |
public byte[] getImageBytes() / public void setImageBytes(byte[] value) |
Setting the value to null
or an empty array will remove the image from the shape.
Returns null
if the image is not stored in the document (e.g the image is probably linked in this case).
getImageSize | |
public ImageSize getImageSize() |
If the image is linked only and not stored in the document, returns zero size.
getImageType | |
public int getImageType() |
isLink | |
public boolean isLink() |
isLinkOnly | |
public boolean isLinkOnly() |
getSourceFullName/setSourceFullName | |
public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value) |
The default value is an empty string.
If
Method Detail |
---|
save | |
public void save(java.io.OutputStream stream) throws java.lang.Exception |
Is it the responsibility of the caller to dispose the stream object.
stream
- The stream where to save the image to.save | |
public void save(java.lang.String fileName) throws java.lang.Exception |
fileName
- The file name where to save the image.setImage | |
public void setImage(java.awt.image.BufferedImage image) throws java.lang.Exception |
image
- The image object.setImage | |
public void setImage(java.io.InputStream stream) throws java.lang.Exception |
stream
- The stream that contains the image.
The stream will be read from the current position, so one should be careful about stream position.setImage | |
public void setImage(java.lang.String fileName) throws java.lang.Exception |
fileName
- The image file. Can be a file name or a URL.toByteArray | |
public byte[] toByteArray() throws java.lang.Exception |
If the image is linked, downloads the image every time it is called.
toImage | |
public java.awt.image.BufferedImage toImage() throws java.lang.Exception |
Tries to create a new java.awt.image.BufferedImage object from image bytes every time this method is called. If javax.imageio.ImageReader can't read image bytes (emf, wmf, tiff, etc.) the method returns null.
It is the responsibility of the caller to dispose the image object.