com.esri.arcgis.display
Class CartographicLineSymbol

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

All Implemented Interfaces:

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

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

A line symbol for drawing solid or dashed lines.

Description

The CartographicLineSymbol can be used to draw solid lines as well as repeating dash patterns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

CartographicLineSymbol()
Constructs a CartographicLineSymbol using ArcGIS Engine.

CartographicLineSymbol(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CartographicLineSymbol theCartographicLineSymbol = (CartographicLineSymbol) 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	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.
int	getCap() Line end cap style.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IColor	getColor() Line symbol color.
Object	getCurrent(Object pUnk) The object currently being used.
int	getJoin() Line join style.
ILineDecoration	getLineDecoration() Line decoration element collection.
double	getLineStartOffset() The line start offset.
int	getMapLevel() Current map level for drawing multi-level symbols.
double	getMiterLimit() Size threshold for showing mitered line joins.
String	getNameString() The display name of an object.
double	getOffset() The line offset value.
int	getROP2() Raster operation code for pixel drawing.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITemplate	getTemplate() The line template.
double	getWidth() Line symbol width.
int	hashCode() the hashcode for this object
boolean	isDecorationOnTop() Indicates if the decoration is drawn on top.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFlip() Indicates if the line symbol is flipped.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
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	setCap(int capStyle) Line end cap style.
void	setColor(IColor color) Line symbol color.
void	setDecorationOnTop(boolean onTop) Indicates if the decoration is drawn on top.
void	setFlip(boolean flip) Indicates if the line symbol is flipped.
void	setJoin(int joinStyle) Line join style.
void	setLineDecorationByRef(ILineDecoration lineDecoration) Line decoration element collection.
void	setLineStartOffset(double offset) The line start offset.
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setMiterLimit(double miterLimit) Size threshold for showing mitered line joins.
void	setOffset(double offset) The line offset value.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setTemplateByRef(ITemplate theTemplate) The line template.
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setWidth(double width) Line symbol width.
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

CartographicLineSymbol

public CartographicLineSymbol()
                       throws IOException,
                              UnknownHostException

Constructs a CartographicLineSymbol using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CartographicLineSymbol

public CartographicLineSymbol(Object obj)
                       throws IOException

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

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

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

getCap

public int getCap()
           throws IOException,
                  AutomationException

Line end cap style.

Description

Cap is the enumeration that defines the line start and end nodes. There are three options: esriLCSButt, esriLCSRound, and esriLCSSquare. esriLCSButt is the default Cap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCap in interface ICartographicLineSymbol

Returns:

A com.esri.arcgis.display.esriLineCapStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCap

public void setCap(int capStyle)
            throws IOException,
                   AutomationException

Line end cap style.

Description

Cap is the enumeration that defines the line start and end nodes. There are three options: esriLCSButt, esriLCSRound, and esriLCSSquare. esriLCSButt is the default Cap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCap in interface ICartographicLineSymbol

Parameters:

capStyle - A com.esri.arcgis.display.esriLineCapStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoin

public int getJoin()
            throws IOException,
                   AutomationException

Line join style.

Description

Join is the enumeration that defines the line bends at vertices. There are three options: esriLJSBevel, esriLCSMitre, and esriLJSRound. esriLJSMitre is the default Join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getJoin in interface ICartographicLineSymbol

Returns:

A com.esri.arcgis.display.esriLineJoinStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoin

public void setJoin(int joinStyle)
             throws IOException,
                    AutomationException

Line join style.

Description

Join is the enumeration that defines the line bends at vertices. There are three options: esriLJSBevel, esriLCSMitre, and esriLJSRound. esriLJSMitre is the default Join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setJoin in interface ICartographicLineSymbol

Parameters:

joinStyle - A com.esri.arcgis.display.esriLineJoinStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMiterLimit

public double getMiterLimit()
                     throws IOException,
                            AutomationException

Size threshold for showing mitered line joins.

Remarks

Not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMiterLimit in interface ICartographicLineSymbol

Returns:

The miterLimit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMiterLimit

public void setMiterLimit(double miterLimit)
                   throws IOException,
                          AutomationException

Size threshold for showing mitered line joins.

Remarks

Not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMiterLimit in interface ICartographicLineSymbol

Parameters:

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

getLineDecoration

public ILineDecoration getLineDecoration()
                                  throws IOException,
                                         AutomationException

Line decoration element collection.

Description

LineDecoration is the line decoration for the current ILineProperties .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineDecoration in interface ILineProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILineDecorationElement, ILineDecoration

setLineDecorationByRef

public void setLineDecorationByRef(ILineDecoration lineDecoration)
                            throws IOException,
                                   AutomationException

Line decoration element collection.

Description

putref_LineDecoration is the line decoration for the current ILineProperties .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineDecorationByRef in interface ILineProperties

Parameters:

lineDecoration - A reference to a com.esri.arcgis.display.ILineDecoration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILineDecorationElement, ILineDecoration

isDecorationOnTop

public boolean isDecorationOnTop()
                          throws IOException,
                                 AutomationException

Indicates if the decoration is drawn on top.

Description

DecorationOnTop is a Boolean indicator for drawing the decorations either above or below the line. The default is False which will draw the line on top of the decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDecorationOnTop in interface ILineProperties

Returns:

The onTop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDecorationOnTop

public void setDecorationOnTop(boolean onTop)
                        throws IOException,
                               AutomationException

Indicates if the decoration is drawn on top.

Description

DecorationOnTop is a Boolean indicator for drawing the decorations either above or below the line. The default is False which will draw the line on top of the decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDecorationOnTop in interface ILineProperties

Parameters:

onTop - The onTop (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFlip

public boolean isFlip()
               throws IOException,
                      AutomationException

Indicates if the line symbol is flipped.

Description

Flip is toggle that tells whether the symbol is drawn based on the FromNode to ToNode direction (false / default) or in the ToNode to FromNode direction (true ).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFlip in interface ILineProperties

Returns:

The flip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlip

public void setFlip(boolean flip)
             throws IOException,
                    AutomationException

Indicates if the line symbol is flipped.

Description

Flip is toggle that tells whether the symbol is drawn based on the FromNode to ToNode direction (false / default) or in the ToNode to FromNode direction (true ).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFlip in interface ILineProperties

Parameters:

flip - The flip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws IOException,
                        AutomationException

The line offset value.

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 ILineProperties

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

The line offset value.

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 ILineProperties

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineStartOffset

public double getLineStartOffset()
                          throws IOException,
                                 AutomationException

The line start offset.

Description

Specifies in points (approx. 1/72 of an inch) the distance the decoration will be offset from the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineStartOffset in interface ILineProperties

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineStartOffset

public void setLineStartOffset(double offset)
                        throws IOException,
                               AutomationException

The line start offset.

Description

Specifies in points (approx. 1/72 of an inch) the distance the decoration will be offset from the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineStartOffset in interface ILineProperties

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplate

public ITemplate getTemplate()
                      throws IOException,
                             AutomationException

The line template.

Description

Template is the template of marks and gaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTemplate in interface ILineProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemplate, ILineProperties.getTemplate(), ILineProperties.setTemplateByRef(com.esri.arcgis.display.ITemplate)

setTemplateByRef

public void setTemplateByRef(ITemplate theTemplate)
                      throws IOException,
                             AutomationException

The line template.

Description

putref_Template is the template of marks and gaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTemplateByRef in interface ILineProperties

Parameters:

theTemplate - A reference to a com.esri.arcgis.display.ITemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemplate, ILineProperties.getTemplate(), ILineProperties.setTemplateByRef(com.esri.arcgis.display.ITemplate)

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.

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.

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.

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