com.esri.arcgis.carto
Interface IAnnotateLayerPropertiesCollection2

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnnotateLayerPropertiesCollection

public interface IAnnotateLayerPropertiesCollection2
extends Serializable

Provides access to members that work with a collection of annotation settings for a feature layer.

Product Availability

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

See Also:

IAnnotateLayerProperties

Method Summary

void	clear() Removes all the items in the collection.
int	getCount() The number of items in the collection.
IAnnotateLayerProperties	getProperties(int iD) The item in the collection with the given id.
int	IAnnotateLayerPropertiesCollection2_add(IAnnotateLayerProperties item) Adds an item to the collection.
void	queryItem(int index, IAnnotateLayerProperties[] item, int[] iD) Returns the item in the collection at the specified index.
void	remove(int iD) Removes the item in the collection with the given id.
void	replace(int iD, IAnnotateLayerProperties pAnnotateLayerProperties) Replaces the item in the collection with the given id.
void	sort() Sorts the items in the collection.

Method Detail

IAnnotateLayerPropertiesCollection2_add

int IAnnotateLayerPropertiesCollection2_add(IAnnotateLayerProperties item)
                                            throws IOException,
                                                   AutomationException

Adds an item to the collection.

Product Availability

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

Parameters:

item - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of items in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

void queryItem(int index,
               IAnnotateLayerProperties[] item,
               int[] iD)
               throws IOException,
                      AutomationException

Returns the item in the collection at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

item - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (out: use single element array)

iD - The iD (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Removes all the items in the collection.

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.

remove

void remove(int iD)
            throws IOException,
                   AutomationException

Removes the item in the collection with the given id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sort

void sort()
          throws IOException,
                 AutomationException

Sorts the items in the collection.

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.

getProperties

IAnnotateLayerProperties getProperties(int iD)
                                       throws IOException,
                                              AutomationException

The item in the collection with the given id.

Product Availability

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

Parameters:

iD - The iD (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replace

void replace(int iD,
             IAnnotateLayerProperties pAnnotateLayerProperties)
             throws IOException,
                    AutomationException

Replaces the item in the collection with the given id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

iD - The iD (in)

pAnnotateLayerProperties - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.