com.esri.arcgis.carto
Interface IGroupElement3

All Superinterfaces:

Serializable

All Known Implementing Classes:

GroupElement

public interface IGroupElement3
extends Serializable

Provides access to members that control the Group element.

Product Availability

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

Method Summary

void	addElement(IElement element) Adds the given element to the group.
void	clearElements() Removes all elements from the group.
void	deleteElement(IElement element) Removes the given element from the group.
IElement	getElement(int index) Element at the given index of the group.
int	getElementCount() Number of elements in the group.
IEnumElement	getElements() Elements in the group.
void	refresh() Let the group know that there has been a change in one or more of the sub-elements.
void	replaceElement(IElement existingElement, IElement newElement) Replace an existing element in the group.
void	setElementsByRef(IEnumElement elements) Elements in the group.

Method Detail

getElements

IEnumElement getElements()
                         throws IOException,
                                AutomationException

Elements in the group.

Product Availability

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

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.

setElementsByRef

void setElementsByRef(IEnumElement elements)
                      throws IOException,
                             AutomationException

Elements in the group.

Product Availability

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

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.

getElementCount

int getElementCount()
                    throws IOException,
                           AutomationException

Number of elements in the group.

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.

getElement

IElement getElement(int index)
                    throws IOException,
                           AutomationException

Element at the given index of the group.

Product Availability

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

Parameters:

index - The index (in)

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.

addElement

void addElement(IElement element)
                throws IOException,
                       AutomationException

Adds the given element to the group.

Product Availability

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

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.

deleteElement

void deleteElement(IElement element)
                   throws IOException,
                          AutomationException

Removes the given element from the group.

Product Availability

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

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.

clearElements

void clearElements()
                   throws IOException,
                          AutomationException

Removes all elements from the group.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Let the group know that there has been a change in one or more of the sub-elements.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceElement

void replaceElement(IElement existingElement,
                    IElement newElement)
                    throws IOException,
                           AutomationException

Replace an existing element in the group.

Product Availability

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

Parameters:

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

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