com.aspose.slides
Interface IPictureFrame

All Known Implementing Classes:
AudioFrame, OleObjectFrame, PictureFrame, VideoFrame

public interface IPictureFrame

Represents standard PictureFrame's properties.


Method Summary
 int getBrightness()
          Returns the brightness (0-100%) of a picture.
 int getColorType()
          Returns the type of color transformation applied to a picture.
 int getContrast()
          Returns the contrast (0-100%) of a picture.
 float getCropBottom()
          Returns the number of percents of real image height that are cropped off from the bottom of the picture.
 float getCropLeft()
          Returns the number of percents of real image width that are cropped off from the left of the picture.
 float getCropRight()
          Returns the number of percents of real image width that are cropped off from the right of the picture.
 float getCropTop()
          Returns the number of percents of real image height that are cropped off from the top of the picture.
 java.lang.String getPictureFileName()
          Returns the file name of a linked picture.
 int getPictureId()
          Returns the picture Id for a PictureFrame.
 RecolorTable getRecolor()
          Returns the table of colors replacements for recoloring metafiles.
 java.awt.Color getTransparentColor()
          Returns the transparent color of a picture.
 boolean isPictureLinked()
          Determines whether the picture is linked to external file.
 void setBrightness(int value)
          Sets the brightness (0-100%) of a picture.
 void setColorType(int value)
          Sets the type of color transformation applied to a picture.
 void setContrast(int value)
          Sets the contrast (0-100%) of a picture.
 void setCropBottom(float value)
          Sets the number of percents of real image height that are cropped off from the bottom of the picture.
 void setCropLeft(float value)
          Sets the number of percents of real image width that are cropped off from the left of the picture.
 void setCropRight(float value)
          Sets the number of percents of real image width that are cropped off from the right of the picture.
 void setCropTop(float value)
          Sets the number of percents of real image height that are cropped off from the top of the picture.
 void setPictureFileName(java.lang.String value)
          Sets the file name of a linked picture.
 void setPictureId(int value)
          Sets the picture Id for a PictureFrame.
 void setTransparentColor(java.awt.Color value)
          sets the transparent color of a picture.
 

Method Detail

getCropTop

float getCropTop()
Returns the number of percents of real image height that are cropped off from the top of the picture.

Returns:
The percents of image height cropped from top.

setCropTop

void setCropTop(float value)
Sets the number of percents of real image height that are cropped off from the top of the picture.

Parameters:
value - the percents of image height cropped from top.

getCropBottom

float getCropBottom()
Returns the number of percents of real image height that are cropped off from the bottom of the picture.

Returns:
The percents of image height cropped from bottom.

setCropBottom

void setCropBottom(float value)
Sets the number of percents of real image height that are cropped off from the bottom of the picture.

Parameters:
value - the percents of image height cropped from bottom.

getCropLeft

float getCropLeft()
Returns the number of percents of real image width that are cropped off from the left of the picture.

Returns:
The percents of image width cropped from left.

setCropLeft

void setCropLeft(float value)
Sets the number of percents of real image width that are cropped off from the left of the picture.

Parameters:
value - the percents of image width cropped from left.

getCropRight

float getCropRight()
Returns the number of percents of real image width that are cropped off from the right of the picture.

Returns:
The percents of image width cropped from right.

setCropRight

void setCropRight(float value)
Sets the number of percents of real image width that are cropped off from the right of the picture.

Parameters:
value - the percents of image width cropped from right.

getTransparentColor

java.awt.Color getTransparentColor()
Returns the transparent color of a picture.

Returns:
the transparent color of a picture. See Color.

setTransparentColor

void setTransparentColor(java.awt.Color value)
sets the transparent color of a picture.

Parameters:
value - the transparent color of a picture. See Color.

getBrightness

int getBrightness()
Returns the brightness (0-100%) of a picture.

Returns:
the brightness (0-100%) of a picture.

setBrightness

void setBrightness(int value)
                   throws PptPropertyException
Sets the brightness (0-100%) of a picture.

Parameters:
value - the brightness (0-100%) of a picture.
Throws:
PptPropertyException

getContrast

int getContrast()
Returns the contrast (0-100%) of a picture.

Returns:
the contrast (0-100%) of a picture.

setContrast

void setContrast(int value)
                 throws PptPropertyException
Sets the contrast (0-100%) of a picture.

Parameters:
value - the contrast (0-100%) of a picture.
Throws:
PptPropertyException

getColorType

int getColorType()
Returns the type of color transformation applied to a picture.

Returns:
the type of color transformation applied to a picture. See PictureColorType.

setColorType

void setColorType(int value)
Sets the type of color transformation applied to a picture.

Parameters:
value - the type of color transformation applied to a picture. See PictureColorType.

getRecolor

RecolorTable getRecolor()
Returns the table of colors replacements for recoloring metafiles.

Returns:
the table of colors replacements for recoloring metafiles. See RecolorTable.

getPictureId

int getPictureId()
Returns the picture Id for a PictureFrame.

Returns:
The picture Id.

setPictureId

void setPictureId(int value)
Sets the picture Id for a PictureFrame.

Parameters:
value - the picture Id.

isPictureLinked

boolean isPictureLinked()
Determines whether the picture is linked to external file.

Returns:
true if picture is linked to external file.

getPictureFileName

java.lang.String getPictureFileName()
Returns the file name of a linked picture.

Returns:
the file name of a linked picture.

setPictureFileName

void setPictureFileName(java.lang.String value)
Sets the file name of a linked picture.

Parameters:
value - the file name of a linked picture.