com.esri.arcgis.controls
Interface IPlaceCollection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPlaceCollectionProxy, MyPlaceCollection

public interface IPlaceCollection
extends java.io.Serializable

COM Interface 'IPlaceCollection'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that manage a place collection. Duplicate names are not allowed.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDc1f4283d_618f_4f9c_bda9_2c9e5f6a0e69
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	add(IPlace pPlace, boolean allowChangeName) Add to place collection.
void	removeAll() Remove all places.
int	removeByName(java.lang.String name, boolean removeMatching) Remove from place collection.

Field Detail

IIDc1f4283d_618f_4f9c_bda9_2c9e5f6a0e69

static final int IIDc1f4283d_618f_4f9c_bda9_2c9e5f6a0e69

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

add

boolean add(IPlace pPlace,
            boolean allowChangeName)
            throws java.io.IOException,
                   AutomationException

Add to place collection. If allowChangeName is true and place with the same name exists, unique name will be assigned, the place will not be added otherwise.

Parameters:

pPlace - A reference to a com.esri.arcgis.controls.IPlace (in)

allowChangeName - The allowChangeName (in)

Returns:

The pAdded

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeByName

int removeByName(java.lang.String name,
                 boolean removeMatching)
                 throws java.io.IOException,
                        AutomationException

Remove from place collection. If RemoveMatching is true, all places will be removed whose name matches the unique name generation pattern. Otherwise place is removed if the name is an exact match.

Parameters:

name - The name (in)

removeMatching - The removeMatching (in)

Returns:

The pRemovedCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws java.io.IOException,
                      AutomationException

Remove all places.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.