com.esri.arcgis.carto
Interface IGraphicsContainer

All Superinterfaces:

Serializable

All Known Implementing Classes:

CompositeGraphicsLayer, FDOGraphicsLayer, GlobeGraphicsLayer, GraphicsLayer3D, GraphicsSubLayer, IGraphicsContainerProxy, Map, PageLayout

public interface IGraphicsContainer
extends Serializable

Provides access to members that control the Graphics Container.

When To Use

Objects which manage a collection of graphic elements implement this interface. For example, the PageLayout, Map, and FDOGraphicsLayer object all implement this interface to provide access to the graphic elements they manage.

The PageLayout object contains a collection of Element objects including, MapFrames, MapSurroundFrames, and GraphicElements such as the PictureElement, MarkerElement and LineElement. The members of this interface provide access to the Elements.

When using this interface to add elements to layer types that operate in a corrdinate system, such as FDOGraphicsLayer and CompositeGraphicsLayer, the elements must implement IGraphicElement.

Product Availability

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

See Also:

IGraphicsContainerSelect

Method Summary

void	addElement(IElement element, int zorder) Add a new graphic element to the layer.
void	addElements(IElementCollection elements, int zorder) Add new graphic elements to the layer.
void	bringForward(IEnumElement elements) Move the specified elements one step closer to the top of the stack of elements.
void	bringToFront(IEnumElement elements) Make the specified elements draw in front of all other elements.
void	deleteAllElements() Delete all the elements.
void	deleteElement(IElement element) Delete the given element.
IFrameElement	findFrame(Object frameObject) Find the frame that contains the specified object.
Object	getElementOrder(IEnumElement elements) Private order object.
IEnumElement	locateElements(IPoint point, double tolerance) Returns the elements at the given coordinate.
IEnumElement	locateElementsByEnvelope(IEnvelope envelope) Returns the elements inside the given envelope.
void	moveElementFromGroup(IGroupElement group, IElement element, int zorder) Move the element from the group to the container.
void	moveElementToGroup(IElement element, IGroupElement group) Move the element from the container to the group.
IElement	next() Returns the next graphic in the container.
void	putElementOrder(Object order) Private order object.
void	reset() Reset internal cursor so that Next returns the first element.
void	sendBackward(IEnumElement elements) Move the specified elements one step closer to the bottom of the stack of elements.
void	sendToBack(IEnumElement elements) Make the specified elements draw behind all other elements.
void	updateElement(IElement element) The graphic element's properties have changed.

Method Detail

next

IElement next()
              throws IOException,
                     AutomationException

Returns the next graphic in the container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.carto.IElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Reset internal cursor so that Next returns the first element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addElement

void addElement(IElement element,
                int zorder)
                throws IOException,
                       AutomationException

Add a new graphic element to the layer.

Description

This method adds the input element the graphics container referenced. The parameter zorder is currently not utilized by all of the IGraphicsContainer implementations and is typically set to 0 when calling this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addElements

void addElements(IElementCollection elements,
                 int zorder)
                 throws IOException,
                        AutomationException

Add new graphic elements to the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

zorder - The zorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteElement

void deleteElement(IElement element)
                   throws IOException,
                          AutomationException

Delete the given element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllElements

void deleteAllElements()
                       throws IOException,
                              AutomationException

Delete all the elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveElementToGroup

void moveElementToGroup(IElement element,
                        IGroupElement group)
                        throws IOException,
                               AutomationException

Move the element from the container to the group.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

group - A reference to a com.esri.arcgis.carto.IGroupElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

void moveElementFromGroup(IGroupElement group,
                          IElement element,
                          int zorder)
                          throws IOException,
                                 AutomationException

Move the element from the group to the container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

group - A reference to a com.esri.arcgis.carto.IGroupElement (in)

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locateElements

IEnumElement locateElements(IPoint point,
                            double tolerance)
                            throws IOException,
                                   AutomationException

Returns the elements at the given coordinate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws IOException,
                                             AutomationException

Returns the elements inside the given envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFrame

IFrameElement findFrame(Object frameObject)
                        throws IOException,
                               AutomationException

Find the frame that contains the specified object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

frameObject - A Variant (in)

Returns:

A reference to a com.esri.arcgis.carto.IFrameElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateElement

void updateElement(IElement element)
                   throws IOException,
                          AutomationException

The graphic element's properties have changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementOrder

Object getElementOrder(IEnumElement elements)
                       throws IOException,
                              AutomationException

Private order object. Used to undo ordering operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putElementOrder

void putElementOrder(Object order)
                     throws IOException,
                            AutomationException

Private order object. Used to undo ordering operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

order - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bringToFront

void bringToFront(IEnumElement elements)
                  throws IOException,
                         AutomationException

Make the specified elements draw in front of all other elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendToBack

void sendToBack(IEnumElement elements)
                throws IOException,
                       AutomationException

Make the specified elements draw behind all other elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendBackward

void sendBackward(IEnumElement elements)
                  throws IOException,
                         AutomationException

Move the specified elements one step closer to the bottom of the stack of elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bringForward

void bringForward(IEnumElement elements)
                  throws IOException,
                         AutomationException

Move the specified elements one step closer to the top of the stack of elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.