com.esri.arcgis.carto
Interface IMaplexLabelStackingProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
MaplexLabelStackingProperties

public interface IMaplexLabelStackingProperties
extends Serializable

Provides access to members that control the placement of stacked labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addSeparator(String separator, boolean visible, boolean splitForced, boolean splitAfter)
          Adds the specified separator to the collection.
 void clearSeparators()
          Removes all the separators in the collection.
 int getMaximumNumberOfCharsPerLine()
          Maximum number of characters allowed on a line.
 int getMaximumNumberOfLines()
          Maximum number of lines on which the label may be stacked.
 int getMinimumNumberOfCharsPerLine()
          Minimum number of characters required on each line.
 int getSeparatorCount()
          The number of separator in the collection.
 int getStackJustification()
          Justification options for label stacking.
 void querySeparator(int index, String[] separator, boolean[] visible, boolean[] splitForced, boolean[] splitAfter)
          Returns the separator in the collection at the specified index.
 void setMaximumNumberOfCharsPerLine(int limit)
          Maximum number of characters allowed on a line.
 void setMaximumNumberOfLines(int limit)
          Maximum number of lines on which the label may be stacked.
 void setMinimumNumberOfCharsPerLine(int limit)
          Minimum number of characters required on each line.
 void setStackJustification(int option)
          Justification options for label stacking.
 

Method Detail

getStackJustification

int getStackJustification()
                          throws IOException,
                                 AutomationException
Justification options for label stacking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriMaplexStackingJustification constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStackJustification

void setStackJustification(int option)
                           throws IOException,
                                  AutomationException
Justification options for label stacking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
option - A com.esri.arcgis.carto.esriMaplexStackingJustification constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSeparator

void addSeparator(String separator,
                  boolean visible,
                  boolean splitForced,
                  boolean splitAfter)
                  throws IOException,
                         AutomationException
Adds the specified separator to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
separator - The separator (in)
visible - The visible (in)
splitForced - The splitForced (in)
splitAfter - The splitAfter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSeparatorCount

int getSeparatorCount()
                      throws IOException,
                             AutomationException
The number of separator 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.

querySeparator

void querySeparator(int index,
                    String[] separator,
                    boolean[] visible,
                    boolean[] splitForced,
                    boolean[] splitAfter)
                    throws IOException,
                           AutomationException
Returns the separator 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)
separator - The separator (out: use single element array)
visible - The visible (out: use single element array)
splitForced - The splitForced (out: use single element array)
splitAfter - The splitAfter (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearSeparators

void clearSeparators()
                     throws IOException,
                            AutomationException
Removes all the separators 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.

getMaximumNumberOfLines

int getMaximumNumberOfLines()
                            throws IOException,
                                   AutomationException
Maximum number of lines on which the label may be stacked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The limit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumNumberOfLines

void setMaximumNumberOfLines(int limit)
                             throws IOException,
                                    AutomationException
Maximum number of lines on which the label may be stacked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
limit - The limit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumNumberOfCharsPerLine

int getMinimumNumberOfCharsPerLine()
                                   throws IOException,
                                          AutomationException
Minimum number of characters required on each line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The limit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumNumberOfCharsPerLine

void setMinimumNumberOfCharsPerLine(int limit)
                                    throws IOException,
                                           AutomationException
Minimum number of characters required on each line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
limit - The limit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumNumberOfCharsPerLine

int getMaximumNumberOfCharsPerLine()
                                   throws IOException,
                                          AutomationException
Maximum number of characters allowed on a line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The limit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumNumberOfCharsPerLine

void setMaximumNumberOfCharsPerLine(int limit)
                                    throws IOException,
                                           AutomationException
Maximum number of characters allowed on a line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
limit - The limit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.