com.aspose.slides
Interface IPictureFrame

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

public interface IPictureFrame

The interface which defines properties of a Picture embedded to a shape.


Method Summary
 int getBrightness()
          Returns the brightness (0-100%) of a picture.
 int getColorType()
          Returns the type of a color transformation applied to a picture.
 int getContrast()
          Returns the contrast (0-100%) of a picture.
 float getCropBottom()
          Returns the number of percents of a real image height that are cropped off from the bottom of a picture.
 float getCropLeft()
          Returns the number of percents of a real image width that are cropped off from the left of a picture.
 float getCropRight()
          Returns the number of percents of a real image width that are cropped off from the right of a picture.
 float getCropTop()
          Returns the number of percents of a real image height that are cropped off from the top of a picture.
 java.lang.String getPictureFileName()
          Returns the file name of a linked picture.
 int getPictureId()
          Returns the Id of an embedded picture.
 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 a 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 a real image height that are cropped off from the bottom of a picture.
 void setCropLeft(float value)
          Sets the number of percents of a real image width that are cropped off from the left of a picture.
 void setCropRight(float value)
          Sets the number of percents of a real image width that are cropped off from the right of a picture.
 void setCropTop(float value)
          Sets the number of percents of a real image height that are cropped off from the top of a picture.
 void setPictureFileName(java.lang.String value)
          Sets the file name of a linked picture.
 void setPictureId(int value)
          Sets the Id of an embedded picture.
 void setTransparentColor(java.awt.Color value)
          Sets the transparent color of a picture.
 

Method Detail

getCropTop

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


setCropTop

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

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

getCropBottom

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


setCropBottom

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

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

getCropLeft

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


setCropLeft

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

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

getCropRight

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


setCropRight

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

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

getTransparentColor

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


setTransparentColor

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

Parameters:
value - the transparent color of a picture.

getBrightness

int getBrightness()
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 - new brightness (0-100%) of a picture.
Throws:
PptPropertyException

getContrast

int getContrast()
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 - new contrast (0-100%) of a picture.
Throws:
PptPropertyException

getColorType

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


setColorType

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

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

getRecolor

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


getPictureId

int getPictureId()
Returns the Id of an embedded picture.


setPictureId

void setPictureId(int value)
Sets the Id of an embedded picture.

Parameters:
value - new Id of a picture.

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 - new file name of a linked picture.