com.esri.arcgis.carto
Interface IPlacedObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasicPlacedObject, IPlacedObjectProxy

public interface IPlacedObject
extends Serializable

Provides access to members work with symbols that are placed as labels.

Superseded By

IPlacedObject3

Product Availability

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

Method Summary

double	getAngle() Angle for the placed object.
int	getClassIndex() Class index of the placed object.
IGeometry	getControlShape() Control shape of the placed object.
int	getFeatureId() FeatureID associated with the placed object.
String	getLabel() Labeling string for the placed object.
int	getObjectType() Type of the placed object.
int	getPlacementCode() Code that indicates success/failure of placement.
String	getPlacementMessage() Placement result message.
void	setClassIndex(int index) Class index of the placed object.
void	setControlShape(IGeometry shape) Control shape of the placed object.
void	setFeatureId(int featureId) FeatureID associated with the placed object.
void	setLabel(String label) Labeling string for the placed object.
void	setObjectType(int type) Type of the placed object.
void	setPlacementCode(int placementCode) Code that indicates success/failure of placement.
void	setPlacementMessage(String message) Placement result message.

Method Detail

getObjectType

int getObjectType()
                  throws IOException,
                         AutomationException

Type of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriPlacedObjectType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectType

void setObjectType(int type)
                   throws IOException,
                          AutomationException

Type of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

type - A com.esri.arcgis.carto.esriPlacedObjectType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureId

int getFeatureId()
                 throws IOException,
                        AutomationException

FeatureID associated with the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The featureId

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureId

void setFeatureId(int featureId)
                  throws IOException,
                         AutomationException

FeatureID associated with the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

featureId - The featureId (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getControlShape

IGeometry getControlShape()
                          throws IOException,
                                 AutomationException

Control shape of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setControlShape

void setControlShape(IGeometry shape)
                     throws IOException,
                            AutomationException

Control shape of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getLabel

String getLabel()
                throws IOException,
                       AutomationException

Labeling string for the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(String label)
              throws IOException,
                     AutomationException

Labeling string for the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassIndex

int getClassIndex()
                  throws IOException,
                         AutomationException

Class index of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassIndex

void setClassIndex(int index)
                   throws IOException,
                          AutomationException

Class index of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacementCode

int getPlacementCode()
                     throws IOException,
                            AutomationException

Code that indicates success/failure of placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriPlacementCode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlacementCode

void setPlacementCode(int placementCode)
                      throws IOException,
                             AutomationException

Code that indicates success/failure of placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

placementCode - A com.esri.arcgis.carto.esriPlacementCode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacementMessage

String getPlacementMessage()
                           throws IOException,
                                  AutomationException

Placement result message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlacementMessage

void setPlacementMessage(String message)
                         throws IOException,
                                AutomationException

Placement result message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

double getAngle()
                throws IOException,
                       AutomationException

Angle for the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.