com.esri.arcgis.carto
Interface IAnnotateLayerPropertiesCollection

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnnotateLayerPropertiesCollection

public interface IAnnotateLayerPropertiesCollection
extends Serializable

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

Superseded By

IAnnotateLayerPropertiesCollection2

When To Use

The IAnnotateLayerPropertiesCollection interface maintains a set of LabelEngineLayerProperties for a feature layer.

Product Availability

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

See Also:

IAnnotateLayerProperties

Method Summary

void	add(IAnnotateLayerProperties item) Adds an item to the collection.
void	clear() Removes all the items in the collection.
int	getCount() The number of items in the collection.
void	queryItem(int index, IAnnotateLayerProperties[] item, IElementCollection[] placedElements, IElementCollection[] unplacedElements) Returns the item in the collection at the specified index.
void	remove(IAnnotateLayerProperties layerprops) Removes the item in the collection at the specified index.
void	sort() Sorts the items in the collection.

Method Detail

add

void add(IAnnotateLayerProperties item)
         throws IOException,
                AutomationException

Adds an item to the collection.

Description

Add adds an item to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of items in the collection.

Description

Count is 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,
               IElementCollection[] placedElements,
               IElementCollection[] unplacedElements)
               throws IOException,
                      AutomationException

Returns the item in the collection at the specified index.

Description

QueryItem returns the specified item from the collection.

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)

placedElements - A reference to a com.esri.arcgis.carto.IElementCollection (out: use single element array, optional, pass single element of null if not required)

unplacedElements - A reference to a com.esri.arcgis.carto.IElementCollection (out: use single element array, optional, pass single element of null if not required)

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.

Description

Clear 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(IAnnotateLayerProperties layerprops)
            throws IOException,
                   AutomationException

Removes the item in the collection at the specified index.

Description

Remove removes the specified item from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

sort

void sort()
          throws IOException,
                 AutomationException

Sorts the items in the collection.

Description

Sort sorts the collection based on the priority of the layer properties.

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.