com.esri.arcgis.display
Interface IGraphicAttributes

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGraphicAttributes2

All Known Implementing Classes:

BasicMarkerSymbol, GeometricEffectAddControlPoints, GeometricEffectArrow, GeometricEffectBuffer, GeometricEffectCut, GeometricEffectDash, GeometricEffectDonut, GeometricEffectEnclosingPolygon, GeometricEffectJog, GeometricEffectMove, GeometricEffectOffset, GeometricEffectRadial, GeometricEffectRegularPolygon, GeometricEffectReverse, GeometricEffectRotate, GeometricEffectScale, GeometricEffectSimplify, GeometricEffectSmooth, GeometricEffectTaperedPolygon, GeometricEffectWave, GradientPattern, LinePattern, LineStroke, MarkerPlacementAlongLine, MarkerPlacementAtExtremities, MarkerPlacementDecoration, MarkerPlacementInsidePolygon, MarkerPlacementOnLine, MarkerPlacementOnPoint, MarkerPlacementOnVertices, MarkerPlacementPolygonCenter, MarkerPlacementRandomAlongLine, MarkerPlacementRandomInPolygon, MarkerPlacementVariableAlongLine, SolidColorPattern

public interface IGraphicAttributes
extends Serializable

Provides access to members that control the graphic attributes.

Superseded By

IGraphicAttributes2

Description

IGraphicAttributes has methods that define a list of graphic attributes for a number of objects such as GeometricEffects, MarkerPlacements, BasicSymbols including BasicMarkerSymbol, BasicFillSymbol and BasicMarkerSymbol, FillPatterns including SolidColorPattern, GradientPattern and LinePattern.

The following enumerations contain all graphic attributes for the above objects: esriGeometricEffectAttributes, esriGraphicAttribute and esriMarkerPlacementAttributes

Remarks

IGraphicAtributes interface must to be implemented by a custom marker placement, geometric effect or fill pattern.

ClassName defines the name of the object for which the attributes are listed.

ClassName will return the name of the Class object implementing this interface. For all Marker Placements, this property will return the type of the marker placement. For example, for a MarkerPlacementOnPoint, ClassName property will return a string "OnPoint". Similarly, use this interface for retreiving the class names for all types of FillPatterns and GeometricEffects Classes as well.

GraphicAttributeCount is a long and indicates the total numer of attributes present for a particular object. ID is a long and indicates the unique identifier of the attribute. Name is a string that indicates the name of the attribute. Type references to an object implementing IGraphicAttributeType. Use IGraphicAttributeType.Type property to determine the type from the following enumeration esriGraphicAttributeType. Value is a variant that can be used to either set or retrieve value from the attribute.

ID, Name, Type, IDByName and Value are methods that define each individual attribute within the graphic attributes list.

GeometricEffectOffset is a geometric effect used to offset line or polygon geometries by an offset distance. The ClassName for this object is Offset Curve and it consists of a single attribute with ID equal to 0 and name as Offset. The Attribute type is esriAttributeTypeDouble.

The following VB code explains the usage of this interface.

When To Use

Use IGraphicAttributes interface for making overrides to the graphic attributes of either Basic Symbols, Geometric Effects, Marker Placements, Fill Patterns or for custom created objects.

Product Availability

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

Method Summary

String	getClassName() Class name of the graphic attribute.
int	getGraphicAttributeCount() Number of graphic attributes.
int	getID(int attrIndex) ID of graphic attributes.
int	getIDByName(String name) ID of the graphic attribute, given its name.
String	getName(int attrId) Name of the graphic attribute.
IGraphicAttributeType	getType(int attrId) Type of the graphic attribute.
Object	getValue(int attrId) Value of the graphic attribute.
void	setValue(int attrId, Object val) Value of the graphic attribute.

Method Detail

getGraphicAttributeCount

int getGraphicAttributeCount()
                             throws IOException,
                                    AutomationException

Number of graphic attributes.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

int getID(int attrIndex)
          throws IOException,
                 AutomationException

ID of graphic attributes.

Product Availability

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

Parameters:

attrIndex - The attrIndex (in)

Returns:

The attrId

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName(int attrId)
               throws IOException,
                      AutomationException

Name of the graphic attribute.

Product Availability

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

Parameters:

attrId - The attrId (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

IGraphicAttributeType getType(int attrId)
                              throws IOException,
                                     AutomationException

Type of the graphic attribute.

Product Availability

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

Parameters:

attrId - The attrId (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue(int attrId)
                throws IOException,
                       AutomationException

Value of the graphic attribute. To erase override, set value to NULL or to original value.

Product Availability

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

Parameters:

attrId - The attrId (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(int attrId,
              Object val)
              throws IOException,
                     AutomationException

Value of the graphic attribute. To erase override, set value to NULL or to original value.

Product Availability

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

Parameters:

attrId - The attrId (in)

val - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDByName

int getIDByName(String name)
                throws IOException,
                       AutomationException

ID of the graphic attribute, given its name.

Product Availability

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

Parameters:

name - The name (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassName

String getClassName()
                    throws IOException,
                           AutomationException

Class name of the graphic attribute.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.