com.esri.arcgis.catalog
Interface IGxSelection

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxSelection

public interface IGxSelection
extends Serializable

Provides access to members that manages the selection within the catalog.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	clear(Object initiator) Unselects all objects.
int	getCount() The number of selected objects.
IGxObject	getFirstObject() The first object in the selection.
IGxObject	getLocation() The location of the selection.
IEnumGxObject	getSelectedObjects() The objects in the selection.
boolean	isDelayEvents() Delays or resumes selection event firing.
boolean	isSelected(IGxObject object) Checks if an object is selected.
void	select(IGxObject object, boolean appendToExistingSelection, Object initiator) Selects an object, optionally appending it to the existing selection.
void	setDelayEvents(boolean delayEvents) Delays or resumes selection event firing.
void	setLocation(IGxObject location, Object pInitiator) Clears the selection and sets a new location.
void	unselect(IGxObject object, Object initiator) Unselects an object.

Method Detail

getLocation

IGxObject getLocation()
                      throws IOException,
                             AutomationException

The location of the selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocation

void setLocation(IGxObject location,
                 Object pInitiator)
                 throws IOException,
                        AutomationException

Clears the selection and sets a new location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

location - A reference to a com.esri.arcgis.catalog.IGxObject (in)

pInitiator - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of selected objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstObject

IGxObject getFirstObject()
                         throws IOException,
                                AutomationException

The first object in the selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDelayEvents

void setDelayEvents(boolean delayEvents)
                    throws IOException,
                           AutomationException

Delays or resumes selection event firing. If the selection changed while events were being delayed, a single event is fired when events are resumed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

delayEvents - The delayEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDelayEvents

boolean isDelayEvents()
                      throws IOException,
                             AutomationException

Delays or resumes selection event firing. If the selection changed while events were being delayed, a single event is fired when events are resumed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The delayEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

select

void select(IGxObject object,
            boolean appendToExistingSelection,
            Object initiator)
            throws IOException,
                   AutomationException

Selects an object, optionally appending it to the existing selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

appendToExistingSelection - The appendToExistingSelection (in)

initiator - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unselect

void unselect(IGxObject object,
              Object initiator)
              throws IOException,
                     AutomationException

Unselects an object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

initiator - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSelected

boolean isSelected(IGxObject object)
                   throws IOException,
                          AutomationException

Checks if an object is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The isSelected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear(Object initiator)
           throws IOException,
                  AutomationException

Unselects all objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

initiator - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedObjects

IEnumGxObject getSelectedObjects()
                                 throws IOException,
                                        AutomationException

The objects in the selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.