com.esri.arcgis.display
Class SimpleMarkerSymbol

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

All Implemented Interfaces:

IDisplayName, IMapLevel, IMarkerMask, IMarkerSymbol, ISimpleMarkerSymbol, ISymbol, ISymbolRotation, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, IXMLSerialize, Externalizable, Serializable

public class SimpleMarkerSymbol
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISimpleMarkerSymbol, IMapLevel, ISymbol, ISymbolRotation, IMarkerMask, IPropertySupport, IPersistStream, IPersist, IClone, IDisplayName, IXMLSerialize, Externalizable

A marker symbol comprised of a predefined set of styles.

Description

The SimpleMarkerSymbol is used to create a marker symbol comprised of a predefinded set of styles. The SimpleMarkerSymbol determines the shape of the simple symbol and also its outline characteristics.

The Style property determines the basic shape of the symbol and can be set to one of five basic shapes using the esriSimpleMarkerStyle constants. These simple shapes can be enhanced with outlines. Try setting the Outline property to True and setting and IColor onto the OutlineColor property.

The OutlineSize property determines the thickness of the outline in printer's points. Bear in mind that the outline is drawn on top of the symbol and will overlap the symbol by half its thickness. By default, a simple marker symbol will be a circle with no outline. The default OutlineColor is black, and the default OutlineSize is 0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

SimpleMarkerSymbol()
Constructs a SimpleMarkerSymbol using ArcGIS Engine.

SimpleMarkerSymbol(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SimpleMarkerSymbol theSimpleMarkerSymbol = (SimpleMarkerSymbol) 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	deserialize(IXMLSerializeData data) Deserializes an object from XML.
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.
double	getAngle() Marker symbol angle.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IColor	getColor() Marker 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.
IColor	getOutlineColor() Outline color.
double	getOutlineSize() Outline diameter.
int	getROP2() Raster operation code for pixel drawing.
double	getSize() Marker symbol size.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStyle() Marker style.
double	getXOffset() Symbol X-axis offset from point location.
double	getYOffset() Symbol Y-axis offset from point location.
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	isOutline() Indicates if the symbol outline will draw.
boolean	isRotateWithTransform() Indicates if the symbol rotates with the display.
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	queryMarkerMask(int hDC, ITransformation transform, IGeometry geometry, IPolygon boundary) Returns the mask geometry for the marker.
void	readExternal(ObjectInput in)
void	resetDC() Restores DC to original state.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAngle(double angle) Marker symbol angle.
void	setColor(IColor color) Marker symbol color.
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setOutline(boolean outline) Indicates if the symbol outline will draw.
void	setOutlineColor(IColor outlineColor) Outline color.
void	setOutlineSize(double size) Outline diameter.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setRotateWithTransform(boolean flag) Indicates if the symbol rotates with the display.
void	setSize(double size) Marker symbol size.
void	setStyle(int style) Marker style.
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setXOffset(double xOffset) Symbol X-axis offset from point location.
void	setYOffset(double yOffset) Symbol Y-axis offset from point location.
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

SimpleMarkerSymbol

public SimpleMarkerSymbol()
                   throws IOException,
                          UnknownHostException

Constructs a SimpleMarkerSymbol using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SimpleMarkerSymbol

public SimpleMarkerSymbol(Object obj)
                   throws IOException

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

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

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

getStyle

public int getStyle()
             throws IOException,
                    AutomationException

Marker style.

Description

Style is the enumeration that controls the pattern used as the marker. The avaialble line options include: esriSMSCircle, esriSMSCross, esriSMSDiamond, esriSMSSquare and esriSMSX. esriSMSCircle is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStyle in interface ISimpleMarkerSymbol

Returns:

A com.esri.arcgis.display.esriSimpleMarkerStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(int style)
              throws IOException,
                     AutomationException

Marker style.

Description

Style is the enumeration that controls the pattern used as the marker. The avaialble line options include: esriSMSCircle, esriSMSCross, esriSMSDiamond, esriSMSSquare and esriSMSX. esriSMSCircle is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStyle in interface ISimpleMarkerSymbol

Parameters:

style - A com.esri.arcgis.display.esriSimpleMarkerStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutline

public boolean isOutline()
                  throws IOException,
                         AutomationException

Indicates if the symbol outline will draw.

Description

Boolean indicator to draw an outline around the marker. False is the default Outline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOutline in interface ISimpleMarkerSymbol

Returns:

The outline

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutline

public void setOutline(boolean outline)
                throws IOException,
                       AutomationException

Indicates if the symbol outline will draw.

Description

Boolean indicator to draw an outline around the marker. False is the default Outline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutline in interface ISimpleMarkerSymbol

Parameters:

outline - The outline (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutlineSize

public double getOutlineSize()
                      throws IOException,
                             AutomationException

Outline diameter.

Description

OutlineSize is the width of the outline in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutlineSize in interface ISimpleMarkerSymbol

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutlineSize

public void setOutlineSize(double size)
                    throws IOException,
                           AutomationException

Outline diameter.

Description

OutlineSize is the width of the outline in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutlineSize in interface ISimpleMarkerSymbol

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutlineColor

public IColor getOutlineColor()
                       throws IOException,
                              AutomationException

Outline color.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutlineColor in interface ISimpleMarkerSymbol

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.

setOutlineColor

public void setOutlineColor(IColor outlineColor)
                     throws IOException,
                            AutomationException

Outline color.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutlineColor in interface ISimpleMarkerSymbol

Parameters:

outlineColor - 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.

getSize

public double getSize()
               throws IOException,
                      AutomationException

Marker symbol size.

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSize in interface IMarkerSymbol

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws IOException,
                    AutomationException

Marker symbol size.

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSize in interface IMarkerSymbol

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws IOException,
                       AutomationException

Marker symbol color.

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.

Color is not supported by the BarChartSymbol coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColor in interface IMarkerSymbol

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.

See Also:

IHsvColor, IHlsColor

setColor

public void setColor(IColor color)
              throws IOException,
                     AutomationException

Marker symbol color.

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.

Color is not supported by the BarChartSymbol coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColor in interface IMarkerSymbol

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.

See Also:

IHsvColor, IHlsColor

getAngle

public double getAngle()
                throws IOException,
                       AutomationException

Marker symbol angle.

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).

Angle is not supported by the BarChartSymbol coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAngle in interface IMarkerSymbol

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angle)
              throws IOException,
                     AutomationException

Marker symbol angle.

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).

Angle is not supported by the BarChartSymbol coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAngle in interface IMarkerSymbol

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOffset

public double getXOffset()
                  throws IOException,
                         AutomationException

Symbol X-axis offset from point location.

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXOffset in interface IMarkerSymbol

Returns:

The xOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws IOException,
                       AutomationException

Symbol X-axis offset from point location.

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXOffset in interface IMarkerSymbol

Parameters:

xOffset - The xOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYOffset

public double getYOffset()
                  throws IOException,
                         AutomationException

Symbol Y-axis offset from point location.

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getYOffset in interface IMarkerSymbol

Returns:

The yOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYOffset

public void setYOffset(double yOffset)
                throws IOException,
                       AutomationException

Symbol Y-axis offset from point location.

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYOffset in interface IMarkerSymbol

Parameters:

yOffset - The yOffset (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.

isRotateWithTransform

public boolean isRotateWithTransform()
                              throws IOException,
                                     AutomationException

Indicates if the symbol rotates with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRotateWithTransform in interface ISymbolRotation

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotateWithTransform

public void setRotateWithTransform(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if the symbol rotates with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotateWithTransform in interface ISymbolRotation

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryMarkerMask

public void queryMarkerMask(int hDC,
                            ITransformation transform,
                            IGeometry geometry,
                            IPolygon boundary)
                     throws IOException,
                            AutomationException

Returns the mask geometry for the marker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryMarkerMask in interface IMarkerMask

Parameters:

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

transform - 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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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