com.esri.arcgis.carto
Interface IRepresentationRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

RepresentationRenderer

public interface IRepresentationRenderer
extends Serializable

Provides access to the properties and methods of a RepresentationRenderer.

Remarks

IRepresentationRenderer interface has properties useful for managing a RepresentationRenderer. A Representation Renderer is useful for displaying features using the representation information stored in any of its Representation Classes. RepresentationClass property can be used to set reference to a representation class or to make changes to an existing one.

Use this interface to reference the renderer to any available representation classes using RepresentationClass property so that all features are drawn with associated representation rules and any overriden attributes. Also, once the renderer renders all features, features having null rule values or invisible features may be managed using this interface.

InvalidRuleColor and InvisibleColor properties can be used to change colors and DrawInvalidRule and DrawInvisible properties can be used to control drawing of such feature representations.

The following piece of code shows how to get reference to a representation class using a feature layer in ArcMap which has been rendered using representation renderer.

Product Availability

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

Method Summary

IColor	getInvalidRuleColor() Color used for representations with an invalid rule ID.
IColor	getInvisibleColor() Color used for invisible representations.
IRepresentationClass	getRepresentationClass() Property RepresentationClass.
boolean	isDrawInvalidRule() Indicates if representations with an invalid Rule ID will draw.
boolean	isDrawInvisible() Indicates whether or not invisible representations will be drawn.
void	setDrawInvalidRule(boolean draw) Indicates if representations with an invalid Rule ID will draw.
void	setDrawInvisible(boolean draw) Indicates whether or not invisible representations will be drawn.
void	setInvalidRuleColor(IColor color) Color used for representations with an invalid rule ID.
void	setInvisibleColor(IColor color) Color used for invisible representations.
void	setRepresentationClassByRef(IRepresentationClass repClass) Property RepresentationClass.

Method Detail

setRepresentationClassByRef

void setRepresentationClassByRef(IRepresentationClass repClass)
                                 throws IOException,
                                        AutomationException

Property RepresentationClass.

Description

This is the RepresentationClass referenced by the renderer so that all features are drawn using the representation information present in the representation class. Since a single feature class can have multiple representation classes, any single representation class can be used to draw all of its features.

Product Availability

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

Parameters:

repClass - A reference to a com.esri.arcgis.geodatabase.IRepresentationClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepresentationClass

IRepresentationClass getRepresentationClass()
                                            throws IOException,
                                                   AutomationException

Property RepresentationClass.

Description

This is the RepresentationClass referenced by the renderer so that all features are drawn using the representation information present in the representation class. Since a single feature class can have multiple representation classes, any single representation class can be used to draw all of its features.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRepresentationClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawInvisible

boolean isDrawInvisible()
                        throws IOException,
                               AutomationException

Indicates whether or not invisible representations will be drawn.

Description

DrawInvisible is a boolean that indicates if invisible feature representations will be drawn or not. To change the visibility property use IRepresentaionClass::GraphicAttributes.

For example, if pRepClass is a reference to a representation class then the Viibility property for all its features can be managed as follows:

Dim pGA As IGraphicAttributes
Set pGA = pRepClass.GraphicAttributes
pGA.Value(0) = False 'Make invisible

Product Availability

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

Returns:

The draw

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawInvisible

void setDrawInvisible(boolean draw)
                      throws IOException,
                             AutomationException

Indicates whether or not invisible representations will be drawn.

Product Availability

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

Parameters:

draw - The draw (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvisibleColor

IColor getInvisibleColor()
                         throws IOException,
                                AutomationException

Color used for invisible representations.

Description

InvisibleColor is the color used by the renderer to draw invisible feature representations.

Product Availability

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

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.

setInvisibleColor

void setInvisibleColor(IColor color)
                       throws IOException,
                              AutomationException

Color used for invisible representations.

Product Availability

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

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.

isDrawInvalidRule

boolean isDrawInvalidRule()
                          throws IOException,
                                 AutomationException

Indicates if representations with an invalid Rule ID will draw.

Description

DrawInvalidRule is a boolean that indicates if feature representations having either invalid or null representation rule values will be drawn by the renderer or not.

An invalid representation rule is a rule that does not belong to the collection of RepresentationRules object for that particular RepresentationClass or a rule having null value. Representation rule IDs are stored in the RuleID field of the attribute table.

Product Availability

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

Returns:

The draw

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawInvalidRule

void setDrawInvalidRule(boolean draw)
                        throws IOException,
                               AutomationException

Indicates if representations with an invalid Rule ID will draw.

Product Availability

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

Parameters:

draw - The draw (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidRuleColor

IColor getInvalidRuleColor()
                           throws IOException,
                                  AutomationException

Color used for representations with an invalid rule ID.

Description

InvalidRuleColor is the color used by the renderer to draw all feature representations having invalid representation rule values.

An invalid representation rule is a rule that is not present in the collection of RepresentationRules object for that particular RepresentationClass or a null rule value. Representation rule ID values are stored in the RuleID field of the attribute table.

Product Availability

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

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.

setInvalidRuleColor

void setInvalidRuleColor(IColor color)
                         throws IOException,
                                AutomationException

Color used for representations with an invalid rule ID.

Product Availability

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

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.