com.esri.arcgis.carto
Interface IMaplexKeyNumberGroup

All Superinterfaces:

Serializable

All Known Implementing Classes:

MaplexKeyNumberGroup

public interface IMaplexKeyNumberGroup
extends Serializable

Provides access to members that control a Maplex key numbering group.

Product Availability

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

Method Summary

String	getDelimiterCharacter() The delimiter character used by the key numbering group.
int	getHorizontalAlignment() The horizontal alignment used by the key numbering group.
int	getMaximumNumberOfLines() The maximum number of lines allowed in the key numbering group.
int	getMinimumNumberOfLines() The minimum number of lines allowed in the key numbering group.
String	getName() The name of the key numbering group.
int	getNumberResetType() The type of number reset used by the key numbering group.
void	setDelimiterCharacter(String name) The delimiter character used by the key numbering group.
void	setHorizontalAlignment(int value) The horizontal alignment used by the key numbering group.
void	setMaximumNumberOfLines(int value) The maximum number of lines allowed in the key numbering group.
void	setMinimumNumberOfLines(int value) The minimum number of lines allowed in the key numbering group.
void	setName(String name) The name of the key numbering group.
void	setNumberResetType(int value) The type of number reset used by the key numbering group.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the key numbering group.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The name of the key numbering group.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException

The horizontal alignment used by the key numbering group.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMaplexKeyNumberHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

void setHorizontalAlignment(int value)
                            throws IOException,
                                   AutomationException

The horizontal alignment used by the key numbering group.

Product Availability

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

Parameters:

value - A com.esri.arcgis.carto.esriMaplexKeyNumberHorizontalAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumNumberOfLines

int getMinimumNumberOfLines()
                            throws IOException,
                                   AutomationException

The minimum number of lines allowed in the key numbering group.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumNumberOfLines

void setMinimumNumberOfLines(int value)
                             throws IOException,
                                    AutomationException

The minimum number of lines allowed in the key numbering group.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumNumberOfLines

int getMaximumNumberOfLines()
                            throws IOException,
                                   AutomationException

The maximum number of lines allowed in the key numbering group.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumNumberOfLines

void setMaximumNumberOfLines(int value)
                             throws IOException,
                                    AutomationException

The maximum number of lines allowed in the key numbering group.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDelimiterCharacter

String getDelimiterCharacter()
                             throws IOException,
                                    AutomationException

The delimiter character used by the key numbering group.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDelimiterCharacter

void setDelimiterCharacter(String name)
                           throws IOException,
                                  AutomationException

The delimiter character used by the key numbering group.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberResetType

int getNumberResetType()
                       throws IOException,
                              AutomationException

The type of number reset used by the key numbering group.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMaplexKeyNumberResetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberResetType

void setNumberResetType(int value)
                        throws IOException,
                               AutomationException

The type of number reset used by the key numbering group.

Product Availability

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

Parameters:

value - A com.esri.arcgis.carto.esriMaplexKeyNumberResetType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.