com.esri.arcgis.carto
Interface IMaplexOverposterLayerProperties4

All Superinterfaces:

Serializable

All Known Implementing Classes:

MaplexOverposterLayerProperties

public interface IMaplexOverposterLayerProperties4
extends Serializable

Provides access to members that control the placement of labels for a layer.

Product Availability

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

Method Summary

int	getConnectionType() Indicates the options for connecting line features.
String	getKeyNumberGroupName() The name of the key number group to use for key numbering the labels.
int	getMultiPartOption() Indicates the option for labeling multi-part shapes.
double	getPreferLabelNearJunctionClearance() Indicates the preferred clearance for placing a line label near a junction.
double	getPreferLabelNearMapBorderClearance() Indicates the preferred clearance for placing a line label near the map border.
String	getTruncationMarkerCharacter() The marker character used by the truncation strategy.
int	getTruncationMinimumLength() The minimum length of a label used by the truncation strategy.
String	getTruncationPreferredCharacters() The preferred characters used by the truncation strategy.
boolean	isAllowStraddleStacking() Indicates whether a stacked label may straddle the line feature.
boolean	isCanKeyNumberLabel() Indicates whether to key number the label and feature.
boolean	isEnableConnection() Indicates whether to turn off line connection.
boolean	isLabelLargestPolygon() Indicates whether to label only the largest polygon in a compound polygon feature.
boolean	isPreferLabelNearJunction() Indicates a preference for placing a line label near a junction.
boolean	isPreferLabelNearMapBorder() Indicates a preference for placing a line label near the map border.
boolean	isRemoveExtraLineBreaks() Indicates whether extra line breaks are removed from the label text.
boolean	isRemoveExtraWhiteSpace() Indicates whether extra white space characters are removed from the label text.
boolean	isUseExactSymbolOutline() Use the exact polygon outline of a symbol when measuring the label offset.
void	setAllowStraddleStacking(boolean flag) Indicates whether a stacked label may straddle the line feature.
void	setCanKeyNumberLabel(boolean flag) Indicates whether to key number the label and feature.
void	setConnectionType(int type) Indicates the options for connecting line features.
void	setEnableConnection(boolean flag) Indicates whether to turn off line connection.
void	setKeyNumberGroupName(String name) The name of the key number group to use for key numbering the labels.
void	setLabelLargestPolygon(boolean flag) Indicates whether to label only the largest polygon in a compound polygon feature.
void	setMultiPartOption(int type) Indicates the option for labeling multi-part shapes.
void	setPreferLabelNearJunction(boolean flag) Indicates a preference for placing a line label near a junction.
void	setPreferLabelNearJunctionClearance(double value) Indicates the preferred clearance for placing a line label near a junction.
void	setPreferLabelNearMapBorder(boolean flag) Indicates a preference for placing a line label near the map border.
void	setPreferLabelNearMapBorderClearance(double value) Indicates the preferred clearance for placing a line label near the map border.
void	setRemoveExtraLineBreaks(boolean flag) Indicates whether extra line breaks are removed from the label text.
void	setRemoveExtraWhiteSpace(boolean flag) Indicates whether extra white space characters are removed from the label text.
void	setTruncationMarkerCharacter(String marker) The marker character used by the truncation strategy.
void	setTruncationMinimumLength(int length) The minimum length of a label used by the truncation strategy.
void	setTruncationPreferredCharacters(String characters) The preferred characters used by the truncation strategy.
void	setUseExactSymbolOutline(boolean flag) Use the exact polygon outline of a symbol when measuring the label offset.

Method Detail

isCanKeyNumberLabel

boolean isCanKeyNumberLabel()
                            throws IOException,
                                   AutomationException

Indicates whether to key number the label and feature.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCanKeyNumberLabel

void setCanKeyNumberLabel(boolean flag)
                          throws IOException,
                                 AutomationException

Indicates whether to key number the label and feature.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyNumberGroupName

String getKeyNumberGroupName()
                             throws IOException,
                                    AutomationException

The name of the key number group to use for key numbering the labels.

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.

setKeyNumberGroupName

void setKeyNumberGroupName(String name)
                           throws IOException,
                                  AutomationException

The name of the key number group to use for key numbering the labels.

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.

isUseExactSymbolOutline

boolean isUseExactSymbolOutline()
                                throws IOException,
                                       AutomationException

Use the exact polygon outline of a symbol when measuring the label offset.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseExactSymbolOutline

void setUseExactSymbolOutline(boolean flag)
                              throws IOException,
                                     AutomationException

Use the exact polygon outline of a symbol when measuring the label offset.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTruncationMarkerCharacter

String getTruncationMarkerCharacter()
                                    throws IOException,
                                           AutomationException

The marker character used by the truncation strategy.

Product Availability

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

Returns:

The marker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTruncationMarkerCharacter

void setTruncationMarkerCharacter(String marker)
                                  throws IOException,
                                         AutomationException

The marker character used by the truncation strategy.

Product Availability

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

Parameters:

marker - The marker (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTruncationMinimumLength

int getTruncationMinimumLength()
                               throws IOException,
                                      AutomationException

The minimum length of a label used by the truncation strategy.

Product Availability

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

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTruncationMinimumLength

void setTruncationMinimumLength(int length)
                                throws IOException,
                                       AutomationException

The minimum length of a label used by the truncation strategy.

Product Availability

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

Parameters:

length - The length (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTruncationPreferredCharacters

String getTruncationPreferredCharacters()
                                        throws IOException,
                                               AutomationException

The preferred characters used by the truncation strategy.

Product Availability

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

Returns:

The characters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTruncationPreferredCharacters

void setTruncationPreferredCharacters(String characters)
                                      throws IOException,
                                             AutomationException

The preferred characters used by the truncation strategy.

Product Availability

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

Parameters:

characters - The characters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPreferLabelNearMapBorder

boolean isPreferLabelNearMapBorder()
                                   throws IOException,
                                          AutomationException

Indicates a preference for placing a line label near the map border.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPreferLabelNearMapBorder

void setPreferLabelNearMapBorder(boolean flag)
                                 throws IOException,
                                        AutomationException

Indicates a preference for placing a line label near the map border.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreferLabelNearMapBorderClearance

double getPreferLabelNearMapBorderClearance()
                                            throws IOException,
                                                   AutomationException

Indicates the preferred clearance for placing a line label near the map border.

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.

setPreferLabelNearMapBorderClearance

void setPreferLabelNearMapBorderClearance(double value)
                                          throws IOException,
                                                 AutomationException

Indicates the preferred clearance for placing a line label near the map border.

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.

isPreferLabelNearJunction

boolean isPreferLabelNearJunction()
                                  throws IOException,
                                         AutomationException

Indicates a preference for placing a line label near a junction.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPreferLabelNearJunction

void setPreferLabelNearJunction(boolean flag)
                                throws IOException,
                                       AutomationException

Indicates a preference for placing a line label near a junction.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreferLabelNearJunctionClearance

double getPreferLabelNearJunctionClearance()
                                           throws IOException,
                                                  AutomationException

Indicates the preferred clearance for placing a line label near a junction.

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.

setPreferLabelNearJunctionClearance

void setPreferLabelNearJunctionClearance(double value)
                                         throws IOException,
                                                AutomationException

Indicates the preferred clearance for placing a line label near a junction.

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.

isEnableConnection

boolean isEnableConnection()
                           throws IOException,
                                  AutomationException

Indicates whether to turn off line connection.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableConnection

void setEnableConnection(boolean flag)
                         throws IOException,
                                AutomationException

Indicates whether to turn off line connection.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionType

int getConnectionType()
                      throws IOException,
                             AutomationException

Indicates the options for connecting line features.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMaplexConnectionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionType

void setConnectionType(int type)
                       throws IOException,
                              AutomationException

Indicates the options for connecting line features.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriMaplexConnectionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelLargestPolygon

boolean isLabelLargestPolygon()
                              throws IOException,
                                     AutomationException

Indicates whether to label only the largest polygon in a compound polygon feature.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelLargestPolygon

void setLabelLargestPolygon(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates whether to label only the largest polygon in a compound polygon feature.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMultiPartOption

int getMultiPartOption()
                       throws IOException,
                              AutomationException

Indicates the option for labeling multi-part shapes.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMaplexMultiPartOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultiPartOption

void setMultiPartOption(int type)
                        throws IOException,
                               AutomationException

Indicates the option for labeling multi-part shapes.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriMaplexMultiPartOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowStraddleStacking

boolean isAllowStraddleStacking()
                                throws IOException,
                                       AutomationException

Indicates whether a stacked label may straddle the line feature.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowStraddleStacking

void setAllowStraddleStacking(boolean flag)
                              throws IOException,
                                     AutomationException

Indicates whether a stacked label may straddle the line feature.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveExtraWhiteSpace

boolean isRemoveExtraWhiteSpace()
                                throws IOException,
                                       AutomationException

Indicates whether extra white space characters are removed from the label text.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveExtraWhiteSpace

void setRemoveExtraWhiteSpace(boolean flag)
                              throws IOException,
                                     AutomationException

Indicates whether extra white space characters are removed from the label text.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveExtraLineBreaks

boolean isRemoveExtraLineBreaks()
                                throws IOException,
                                       AutomationException

Indicates whether extra line breaks are removed from the label text.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveExtraLineBreaks

void setRemoveExtraLineBreaks(boolean flag)
                              throws IOException,
                                     AutomationException

Indicates whether extra line breaks are removed from the label text.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.