com.esri.arcgis.carto
Interface IPictureElement5

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BmpPictureElement, EmfPictureElement, GifPictureElement, ImgPictureElement, IPictureElement5Proxy, Jp2PictureElement, JpgPictureElement, PictureElement, PngPictureElement, SidPictureElement, TifPictureElement

public interface IPictureElement5
extends java.io.Serializable

COM Interface 'IPictureElement5'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the Picture element.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDc0a341c6_cfe2_11d1_9140_0000f87808ee
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getAttachmentFilter() Use attachment that has filter in the name.
java.lang.String	getFilter() Filter used in CFileDialog.
int	getHandle() The picture handle as a HBITMAP for bitmap pictures or an HENHMETAFILE for vector pictures.
java.lang.String	getPath() Associated picture file.
double	getPictureAspectRatio() Filter used in CFileDialog.
java.lang.String	getPictureDescription() Description of the Picture Element.
java.lang.String	getPictureField() Field that specifies picture.
void	importFromVariant(java.lang.Object v) Import picture from path, url, raster, or blob.
void	importPictureFromFile(java.lang.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	isUseAttachment() Picture shows attachment.
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	setAttachmentFilter(java.lang.String filter) Use attachment that has filter in the name.
void	setMaintainAspectRatio(boolean bRatio) Indicates if the resize box will maintain the picture's aspect ratio.
void	setPath(java.lang.String path) Associated picture file.
void	setPictureField(java.lang.String fieldName) Field that specifies picture.
void	setSavePictureInDocument(boolean bSaveInDoc) Indicates if the Picture will be stored in the Document.
void	setUseAttachment(boolean flag) Picture shows attachment.

Field Detail

IIDc0a341c6_cfe2_11d1_9140_0000f87808ee

static final int IIDc0a341c6_cfe2_11d1_9140_0000f87808ee

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getPictureDescription

java.lang.String getPictureDescription()
                                       throws java.io.IOException,
                                              AutomationException

Description of the Picture Element.

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException

Filter used in CFileDialog.

Returns:

The filter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPictureAspectRatio

double getPictureAspectRatio()
                             throws java.io.IOException,
                                    AutomationException

Filter used in CFileDialog.

Returns:

The ratio

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMaintainAspectRatio

boolean isMaintainAspectRatio()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the resize box will maintain the picture's aspect ratio.

Returns:

The bRatio

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaintainAspectRatio

void setMaintainAspectRatio(boolean bRatio)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the resize box will maintain the picture's aspect ratio.

Parameters:

bRatio - The bRatio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSavePictureInDocument

boolean isSavePictureInDocument()
                                throws java.io.IOException,
                                       AutomationException

Indicates if the Picture will be stored in the Document.

Returns:

The bSaveInDoc

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSavePictureInDocument

void setSavePictureInDocument(boolean bSaveInDoc)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the Picture will be stored in the Document.

Parameters:

bSaveInDoc - The bSaveInDoc (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importPictureFromFile

void importPictureFromFile(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

File to be imported.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryIntrinsicSize

void queryIntrinsicSize(double[] widthPoints,
                        double[] heightPoints)
                        throws java.io.IOException,
                               AutomationException

Get the intrinsic size of the picture in points.

Parameters:

widthPoints - The widthPoints (in/out: use single element array)

heightPoints - The heightPoints (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVector

boolean isVector()
                 throws java.io.IOException,
                        AutomationException

Indicates whether picture is a vector format as opposed to raster.

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHandle

int getHandle()
              throws java.io.IOException,
                     AutomationException

The picture handle as a HBITMAP for bitmap pictures or an HENHMETAFILE for vector pictures.

Returns:

The handle (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

void setPath(java.lang.String path)
             throws java.io.IOException,
                    AutomationException

Associated picture file.

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException

Associated picture file.

Returns:

The path

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPictureField

java.lang.String getPictureField()
                                 throws java.io.IOException,
                                        AutomationException

Field that specifies picture. Use with data driven pages.

Returns:

The fieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPictureField

void setPictureField(java.lang.String fieldName)
                     throws java.io.IOException,
                            AutomationException

Field that specifies picture. Use with data driven pages.

Parameters:

fieldName - The fieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseAttachment

boolean isUseAttachment()
                        throws java.io.IOException,
                               AutomationException

Picture shows attachment. Use with data driven pages.

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseAttachment

void setUseAttachment(boolean flag)
                      throws java.io.IOException,
                             AutomationException

Picture shows attachment. Use with data driven pages.

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttachmentFilter

java.lang.String getAttachmentFilter()
                                     throws java.io.IOException,
                                            AutomationException

Use attachment that has filter in the name. Use with data driven pages.

Returns:

The filter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttachmentFilter

void setAttachmentFilter(java.lang.String filter)
                         throws java.io.IOException,
                                AutomationException

Use attachment that has filter in the name. Use with data driven pages.

Parameters:

filter - The filter (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importFromVariant

void importFromVariant(java.lang.Object v)
                       throws java.io.IOException,
                              AutomationException

Import picture from path, url, raster, or blob.

Parameters:

v - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.