com.esri.arcgis.display
Class PictureLineSymbol

java.lang.Object
  com.esri.arcgis.display.PictureLineSymbol

All Implemented Interfaces:

IDisplayName, ILineSymbol, IMapLevel, IPictureLineSymbol, ISymbol, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable

public class PictureLineSymbol
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPictureLineSymbol, IMapLevel, ISymbol, IPropertySupport, IPersistStream, IPersist, IClone, IDisplayName, Externalizable

A line symbol composed of either a BMP or an EMF picture.

Description

Use PictureLineSymbol to create a line symbol that is based on the contents of a Windows Bitmap (.bmp), or Enhanced Metafile (.emf) file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

PictureLineSymbol()
Constructs a PictureLineSymbol using ArcGIS Engine.

PictureLineSymbol(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PictureLineSymbol thePictureLineSymbol = (PictureLineSymbol) obj;

Method Summary

boolean	applies(Object pUnk) Indicates if the receiver can apply the given object at any given time.
Object	apply(Object newObject) Applies the given property to the receiver and returns the old object.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	canApply(Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
void	createLineSymbolFromFile(int type, String fileName) Create line symbol from picture file.
void	draw(IGeometry geometry) Draws the specified shape.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IColor	getBackgroundColor() Line background color.
IColor	getBitmapTransparencyColor() Color within bitmap indicating transparency.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IColor	getColor() Line symbol color.
Object	getCurrent(Object pUnk) The object currently being used.
int	getMapLevel() Current map level for drawing multi-level symbols.
String	getNameString() The display name of an object.
double	getOffset() Picture offset from center of line.
Picture	getPicture() Picture used for line.
int	getROP2() Raster operation code for pixel drawing.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getWidth() Line symbol width.
double	getXScale() Scale of picture along X-axis.
double	getYScale() Scale of picture along Y-axis.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isRotate() Indicates if the picture is rotated to follow the line.
boolean	isSwapForeGroundBackGroundColor() Indicates if the foreground and background colors are swapped on 1 Bit Images Only.
void	load(IStream pstm) load
void	queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary) Fills an existing polygon with the boundary of the specified symbol.
void	readExternal(ObjectInput in)
void	resetDC() Restores DC to original state.
void	save(IStream pstm, int fClearDirty) save
void	setBackgroundColor(IColor color) Line background color.
void	setBitmapTransparencyColor(IColor color) Color within bitmap indicating transparency.
void	setColor(IColor color) Line symbol color.
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setOffset(double offset) Picture offset from center of line.
void	setPictureByRef(Picture pictureDisp) Picture used for line.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setRotate(boolean rotate) Indicates if the picture is rotated to follow the line.
void	setSwapForeGroundBackGroundColor(boolean swap) Indicates if the foreground and background colors are swapped on 1 Bit Images Only.
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setWidth(double width) Line symbol width.
void	setXScale(double xScale) Scale of picture along X-axis.
void	setYScale(double yScale) Scale of picture along Y-axis.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

PictureLineSymbol

public PictureLineSymbol()
                  throws IOException,
                         UnknownHostException

Constructs a PictureLineSymbol using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PictureLineSymbol

public PictureLineSymbol(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PictureLineSymbol thePictureLineSymbol = (PictureLineSymbol) obj;

Construct a PictureLineSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PictureLineSymbol.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getPicture

public Picture getPicture()
                   throws IOException,
                          AutomationException

Picture used for line.

Description

Specifies the bitmap image used for the line. Use the IPictureDisp interface to specify the image.

Remarks

Only bitmap images may be specified. Use the CreateFillSymbolFromFile method to access emf files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPicture in interface IPictureLineSymbol

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPictureByRef

public void setPictureByRef(Picture pictureDisp)
                     throws IOException,
                            AutomationException

Picture used for line.

Description

Specifies the bitmap image used for the line. Use the IPictureDisp interface to specify the image.

Remarks

Only bitmap images may be specified. Use the CreateFillSymbolFromFile method to access emf files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPictureByRef in interface IPictureLineSymbol

Parameters:

pictureDisp - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

Line background color.

Description

Controls the Background color of the bitmap image or emf file. Any IColor supporting object may be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackgroundColor in interface IPictureLineSymbol

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException

Line background color.

Description

Controls the Background color of the bitmap image or emf file. Any IColor supporting object may be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundColor in interface IPictureLineSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBitmapTransparencyColor

public void setBitmapTransparencyColor(IColor color)
                                throws IOException,
                                       AutomationException

Color within bitmap indicating transparency.

Description

Changes the specified color within the bitmap to be transparent. BitmapTransparencyColor can be specified as any IColor object.

Remarks

BitmapTransparencyColor is only supported by color bitmap files. Emf files and 1-bit bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBitmapTransparencyColor in interface IPictureLineSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmapTransparencyColor

public IColor getBitmapTransparencyColor()
                                  throws IOException,
                                         AutomationException

Color within bitmap indicating transparency.

Description

Changes the specified color within the bitmap to be transparent. BitmapTransparencyColor can be specified as any IColor object.

Remarks

BitmapTransparencyColor is only supported by color bitmap files. Emf files and 1-bit bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBitmapTransparencyColor in interface IPictureLineSymbol

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRotate

public boolean isRotate()
                 throws IOException,
                        AutomationException

Indicates if the picture is rotated to follow the line.

Description

Boolean indicator to rotate the picture to follow the orientation of the line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRotate in interface IPictureLineSymbol

Returns:

The rotate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotate

public void setRotate(boolean rotate)
               throws IOException,
                      AutomationException

Indicates if the picture is rotated to follow the line.

Description

Boolean indicator to rotate the picture to follow the orientation of the line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotate in interface IPictureLineSymbol

Parameters:

rotate - The rotate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXScale

public double getXScale()
                 throws IOException,
                        AutomationException

Scale of picture along X-axis.

Description

The XScale (horizontal) value of the bitmap image or emf file. XScale is specified as a percentage of the original file. The default XScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXScale in interface IPictureLineSymbol

Returns:

The xScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXScale

public void setXScale(double xScale)
               throws IOException,
                      AutomationException

Scale of picture along X-axis.

Description

The XScale (horizontal) value of the bitmap image or emf file. XScale is specified as a percentage of the original file. The default XScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXScale in interface IPictureLineSymbol

Parameters:

xScale - The xScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYScale

public double getYScale()
                 throws IOException,
                        AutomationException

Scale of picture along Y-axis.

Description

The YScale (vertical) value of the bitmap image or emf file. YScale is specified as a percentage of the original file. The default YScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getYScale in interface IPictureLineSymbol

Returns:

The yScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYScale

public void setYScale(double yScale)
               throws IOException,
                      AutomationException

Scale of picture along Y-axis.

Description

The YScale (vertical) value of the bitmap image or emf file. YScale is specified as a percentage of the original file. The default YScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYScale in interface IPictureLineSymbol

Parameters:

yScale - The yScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws IOException,
                        AutomationException

Picture offset from center of line.

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. The Offset can be a positive (above/left) or negative (below/right) number.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffset in interface IPictureLineSymbol

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double offset)
               throws IOException,
                      AutomationException

Picture offset from center of line.

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. The Offset can be a positive (above/left) or negative (below/right) number.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOffset in interface IPictureLineSymbol

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSwapForeGroundBackGroundColor

public boolean isSwapForeGroundBackGroundColor()
                                        throws IOException,
                                               AutomationException

Indicates if the foreground and background colors are swapped on 1 Bit Images Only.

Description

Boolean indicator to switch the foreground color with the background color of a 1-bit bitmap image.

Remarks

SwapForeGroundBackGroundColor is only supported by 1-bit bitmap files. Emf files and color bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSwapForeGroundBackGroundColor in interface IPictureLineSymbol

Returns:

The swap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSwapForeGroundBackGroundColor

public void setSwapForeGroundBackGroundColor(boolean swap)
                                      throws IOException,
                                             AutomationException

Indicates if the foreground and background colors are swapped on 1 Bit Images Only.

Description

Boolean indicator to switch the foreground color with the background color of a 1-bit bitmap image.

Remarks

SwapForeGroundBackGroundColor is only supported by 1-bit bitmap files. Emf files and color bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSwapForeGroundBackGroundColor in interface IPictureLineSymbol

Parameters:

swap - The swap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createLineSymbolFromFile

public void createLineSymbolFromFile(int type,
                                     String fileName)
                              throws IOException,
                                     AutomationException

Create line symbol from picture file.

Description

Loads the specified bitmap image or emf file. Use the esriPictureType enumerator to specify the type of picture being loaded. Supported types are esriIPictureBitmap (bitmap images) and esriIPictureEMF (emf files).

Remarks

Bitmap images are limited to a maxiumum of 256 colors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createLineSymbolFromFile in interface IPictureLineSymbol

Parameters:

type - A com.esri.arcgis.display.esriIPictureType constant (in)

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws IOException,
                       AutomationException

Line symbol color.

Description

Color is the color for a LineSymbol object. Any IColor object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColor in interface ILineSymbol

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(IColor color)
              throws IOException,
                     AutomationException

Line symbol color.

Description

Color is the color for a LineSymbol object. Any IColor object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColor in interface ILineSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws IOException,
                       AutomationException

Line symbol width.

Description

Width returns or Sets the Double (ASCII) number in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface ILineSymbol

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(double width)
              throws IOException,
                     AutomationException

Line symbol width.

Description

Width returns the Double (ASCII) number in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface ILineSymbol

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapLevel in interface IMapLevel

Parameters:

mapLevel - The mapLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws IOException,
                    AutomationException

Prepares the DC for drawing the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setupDC in interface ISymbol

Parameters:

hDC - The hDC (A COM typedef) (in)

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetDC

public void resetDC()
             throws IOException,
                    AutomationException

Restores DC to original state.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetDC in interface ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws IOException,
                 AutomationException

Draws the specified shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ISymbol

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation displayTransform,
                          IGeometry geometry,
                          IPolygon boundary)
                   throws IOException,
                          AutomationException

Fills an existing polygon with the boundary of the specified symbol.

Remarks

Valid input Geometries are as follows:

For MarkerSymbols, the Geometry must be an IPoint.

For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.

For Line Symbols, the Geometry must be an IPolyline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryBoundary in interface ISymbol

Parameters:

hDC - The hDC (A COM typedef) (in)

displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getROP2

public int getROP2()
            throws IOException,
                   AutomationException

Raster operation code for pixel drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getROP2 in interface ISymbol

Returns:

A com.esri.arcgis.display.esriRasterOpCode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setROP2

public void setROP2(int drawMode)
             throws IOException,
                    AutomationException

Raster operation code for pixel drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setROP2 in interface ISymbol

Parameters:

drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The display name of an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IDisplayName

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException