com.esri.arcgis.carto
Interface IPictureElement3

All Superinterfaces:
Serializable
All Known Implementing Classes:
BmpPictureElement, EmfPictureElement, GifPictureElement, ImgPictureElement, Jp2PictureElement, JpgPictureElement, PictureElement, PngPictureElement, SidPictureElement, TifPictureElement

public interface IPictureElement3
extends Serializable

Provides access to members that control the Picture element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 String getFilter()
          Filter used in CFileDialog.
 int getHandle()
          The picture handle as a HBITMAP for bitmap pictures or an HENHMETAFILE for vector pictures.
 double getPictureAspectRatio()
          Filter used in CFileDialog.
 String getPictureDescription()
          Description of the Picture Element.
 void importPictureFromFile(String name)
          File to be imported.
 boolean isMaintainAspectRatio()
          Indicates if the resize box will maintain the picture's aspect ratio.
 boolean isSavePictureInDocument()
          Indicates if the Picture will be stored in the Document.
 boolean isVector()
          Indicates whether picture is a vector format as opposed to raster.
 void queryIntrinsicSize(double[] widthPoints, double[] heightPoints)
          Get the intrinsic size of the picture in points.
 void setMaintainAspectRatio(boolean bRatio)
          Indicates if the resize box will maintain the picture's aspect ratio.
 void setSavePictureInDocument(boolean bSaveInDoc)
          Indicates if the Picture will be stored in the Document.
 

Method Detail

getPictureDescription

String getPictureDescription()
                             throws IOException,
                                    AutomationException
Description of the Picture Element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilter

String getFilter()
                 throws IOException,
                        AutomationException
Filter used in CFileDialog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The filter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPictureAspectRatio

double getPictureAspectRatio()
                             throws IOException,
                                    AutomationException
Filter used in CFileDialog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The ratio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMaintainAspectRatio

boolean isMaintainAspectRatio()
                              throws IOException,
                                     AutomationException
Indicates if the resize box will maintain the picture's aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The bRatio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaintainAspectRatio

void setMaintainAspectRatio(boolean bRatio)
                            throws IOException,
                                   AutomationException
Indicates if the resize box will maintain the picture's aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
bRatio - The bRatio (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSavePictureInDocument

boolean isSavePictureInDocument()
                                throws IOException,
                                       AutomationException
Indicates if the Picture will be stored in the Document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The bSaveInDoc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSavePictureInDocument

void setSavePictureInDocument(boolean bSaveInDoc)
                              throws IOException,
                                     AutomationException
Indicates if the Picture will be stored in the Document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
bSaveInDoc - The bSaveInDoc (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

importPictureFromFile

void importPictureFromFile(String name)
                           throws IOException,
                                  AutomationException
File to be imported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryIntrinsicSize

void queryIntrinsicSize(double[] widthPoints,
                        double[] heightPoints)
                        throws IOException,
                               AutomationException
Get the intrinsic size of the picture in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
widthPoints - The widthPoints (in/out: use single element array)
heightPoints - The heightPoints (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVector

boolean isVector()
                 throws IOException,
                        AutomationException
Indicates whether picture is a vector format as opposed to raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHandle

int getHandle()
              throws IOException,
                     AutomationException
The picture handle as a HBITMAP for bitmap pictures or an HENHMETAFILE for vector pictures.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The handle (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.