com.spire.doc.interfaces
Interface IPicture

All Superinterfaces:

IDocumentObject, IParagraphBase

All Known Implementing Classes:

DocPicture

public interface IPicture
extends IParagraphBase

Represents a picture in a word document.

Method Summary

IParagraph	addCaption(java.lang.String name, CaptionNumberingFormat format, CaptionPosition captionPosition) Add Caption for current Picture
java.lang.String	getAlternativeText() Gets the picture's alternative text.
float	getHeight() Returns picture height.
float	getHeightScale() Returns picture height scale factor in percent.
ShapeHorizontalAlignment	getHorizontalAlignment() Returns picture horizontal alignment.
HorizontalOrigin	getHorizontalOrigin() Gets horizontal origin of the picture.
float	getHorizontalPosition() Gets absolute horizontal position of the picture.
java.awt.image.BufferedImage	getImage() Gets internal System.Drawing.Image object.
byte[]	getImageBytes() Gets image byte array.
TextWrappingStyle	getTextWrappingStyle() Gets text wrapping style of the picture.
TextWrappingType	getTextWrappingType() Gets text wrapping type of the picture.
java.lang.String	getTitle() Gets the picture's title
ShapeVerticalAlignment	getVerticalAlignment() Returns picture vertical alignment.
VerticalOrigin	getVerticalOrigin() Gets vertical origin of the picture.
float	getVerticalPosition() Gets absolute vertical position of the picture.
float	getWidth() Returns picture width.
float	getWidthScale() Returns picture width scale factor in percent.
boolean	isUnderText()
void	isUnderText(boolean value)
void	loadImage(byte[] imageBytes) Loads System.Drawing.Image as byte array.
void	loadImage(java.io.InputStream inputStream) Loads System.Drawing.Image object.
void	loadImage(java.lang.String filePath) Loads System.Drawing.Image object.
void	setAlternativeText(java.lang.String value) Sets the picture's alternative text.
void	setHeight(float value) Sets picture height.
void	setHeightScale(float value) Sets picture height scale factor in percent.
void	setHorizontalAlignment(ShapeHorizontalAlignment value) Sets picture horizontal alignment.
void	setHorizontalOrigin(HorizontalOrigin value) Sets horizontal origin of the picture.
void	setHorizontalPosition(float value) Sets absolute horizontal position of the picture.
void	setTextWrappingStyle(TextWrappingStyle value) Sets text wrapping style of the picture.
void	setTextWrappingType(TextWrappingType value) Sets text wrapping type of the picture.
void	setTitle(java.lang.String value) sets the picture's title
void	setVerticalAlignment(ShapeVerticalAlignment value) Sets picture vertical alignment.
void	setVerticalOrigin(VerticalOrigin value) Sets vertical origin of the picture.
void	setVerticalPosition(float value) Sets absolute vertical position of the picture.
void	setWidth(float value) Sets picture width.
void	setWidthScale(float value) Sets picture width scale factor in percent.

Methods inherited from interface com.spire.doc.interfaces.IParagraphBase

applyStyle, getOwnerParagraph, getStyleName

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getDocumentObjectType, getNextSibling, getOwner, getPreviousSibling, isComposite

Method Detail

getHeight

float getHeight()

Returns picture height.

Returns:

The value is measured in points.

setHeight

void setHeight(float value)

Sets picture height.

Parameters:

value - The value is measured in points.

getWidth

float getWidth()

Returns picture width.

Returns:

The value is measured in points.

setWidth

void setWidth(float value)

Sets picture width.

Parameters:

value - The value is measured in points.

getHeightScale

float getHeightScale()

Returns picture height scale factor in percent.

Returns:

float

setHeightScale

void setHeightScale(float value)

Sets picture height scale factor in percent.

Parameters:

value - float

getWidthScale

float getWidthScale()

Returns picture width scale factor in percent.

Returns:

float

setWidthScale

void setWidthScale(float value)

Sets picture width scale factor in percent.

Parameters:

value - float

loadImage

void loadImage(java.io.InputStream inputStream)

Loads System.Drawing.Image object.

Parameters:

inputStream - the image input stream

loadImage

void loadImage(java.lang.String filePath)

Loads System.Drawing.Image object.

Parameters:

filePath - the image file path

getImage

java.awt.image.BufferedImage getImage()

Gets internal System.Drawing.Image object.

Returns:

BufferedImage

loadImage

void loadImage(byte[] imageBytes)

Loads System.Drawing.Image as byte array.

Parameters:

imageBytes - imageBytes

getImageBytes

byte[] getImageBytes()

Gets image byte array.

Returns:

byte[]

addCaption

IParagraph addCaption(java.lang.String name,
                      CaptionNumberingFormat format,
                      CaptionPosition captionPosition)

Add Caption for current Picture

Parameters:

name - name

format - format

captionPosition - captionPosition

Returns:

IParagraph

getHorizontalOrigin

HorizontalOrigin getHorizontalOrigin()

Gets horizontal origin of the picture.

Returns:

HorizontalOrigin

setHorizontalOrigin

void setHorizontalOrigin(HorizontalOrigin value)

Sets horizontal origin of the picture.

Parameters:

value - HorizontalOrigin

getVerticalOrigin

VerticalOrigin getVerticalOrigin()

Gets vertical origin of the picture.

Returns:

VerticalOrigin

setVerticalOrigin

void setVerticalOrigin(VerticalOrigin value)

Sets vertical origin of the picture.

Parameters:

value - VerticalOrigin

getHorizontalPosition

float getHorizontalPosition()

Gets absolute horizontal position of the picture.

Returns:

the value is measured in points and the position is relative to HorizontalOrigin.

setHorizontalPosition

void setHorizontalPosition(float value)

Sets absolute horizontal position of the picture.

Parameters:

value - the value is measured in points and the position is relative to HorizontalOrigin.

getVerticalPosition

float getVerticalPosition()

Gets absolute vertical position of the picture.

Returns:

the value is measured in points and the position is relative to VerticalOrigin.

setVerticalPosition

void setVerticalPosition(float value)

Sets absolute vertical position of the picture.

Parameters:

value - the value is measured in points and the position is relative to VerticalOrigin.

getTextWrappingStyle

TextWrappingStyle getTextWrappingStyle()

Gets text wrapping style of the picture.

Returns:

TextWrappingStyle

setTextWrappingStyle

void setTextWrappingStyle(TextWrappingStyle value)

Sets text wrapping style of the picture.

Parameters:

value - TextWrappingStyle

getTextWrappingType

TextWrappingType getTextWrappingType()

Gets text wrapping type of the picture.

Returns:

TextWrappingType

setTextWrappingType

void setTextWrappingType(TextWrappingType value)

Sets text wrapping type of the picture.

Parameters:

value - TextWrappingType

getHorizontalAlignment

ShapeHorizontalAlignment getHorizontalAlignment()

Returns picture horizontal alignment. If it is set as None, then the object is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to HorizontalOrigin.

Returns:

ShapeHorizontalAlignment

setHorizontalAlignment

void setHorizontalAlignment(ShapeHorizontalAlignment value)

Sets picture horizontal alignment. If it is set as None, then the object is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to HorizontalOrigin.

Parameters:

value - ShapeHorizontalAlignment

getVerticalAlignment

ShapeVerticalAlignment getVerticalAlignment()

Returns picture vertical alignment. If it is set as None, then the object is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to VerticalOrigin.

Returns:

ShapeVerticalAlignment

setVerticalAlignment

void setVerticalAlignment(ShapeVerticalAlignment value)

Sets picture vertical alignment. If it is set as None, then the object is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to VerticalOrigin.

Parameters:

value - ShapeVerticalAlignment

getAlternativeText

java.lang.String getAlternativeText()

Gets the picture's alternative text.

Returns:

the alternative text.

setAlternativeText

void setAlternativeText(java.lang.String value)

Sets the picture's alternative text.

Parameters:

value - the alternative text.

getTitle

java.lang.String getTitle()

Gets the picture's title

Returns:

the title text

setTitle

void setTitle(java.lang.String value)

sets the picture's title

Parameters:

value - the title text

isUnderText

boolean isUnderText()

isUnderText

void isUnderText(boolean value)