com.esri.arcgis.display
Interface ITextMargins

All Superinterfaces:

Serializable

All Known Implementing Classes:

BalloonCallout, LineCallout

public interface ITextMargins
extends Serializable

Provides access to members that control the text margins.

Description

TextMargins control the distance between the text and the edge of the IBalloonCallout or ILineCallout. Each side, left, right, top and bottom can be given a unique value.

Product Availability

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

See Also:

IBalloonCallout

Method Summary

double	getBottomMargin() Value for the bottom margin.
double	getLeftMargin() Value for the left margin.
double	getRightMargin() Value for the right margin.
double	getTopMargin() Value for the top margin.
void	putMargins(double left, double top, double right, double bottom) Sets the margins.
void	queryMargins(double[] left, double[] top, double[] right, double[] bottom) Returns the margins.
void	setBottomMargin(double bottomMargin) Value for the bottom margin.
void	setLeftMargin(double leftMargin) Value for the left margin.
void	setRightMargin(double rightMargin) Value for the right margin.
void	setTopMargin(double topMargin) Value for the top margin.

Method Detail

getLeftMargin

double getLeftMargin()
                     throws IOException,
                            AutomationException

Value for the left margin.

Description

LeftMargin specifies the distance between the text and the left edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The leftMargin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftMargin

void setLeftMargin(double leftMargin)
                   throws IOException,
                          AutomationException

Value for the left margin.

Description

LeftMargin specifies the distance between the text and the left edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

leftMargin - The leftMargin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRightMargin

double getRightMargin()
                      throws IOException,
                             AutomationException

Value for the right margin.

Description

RightMargin specifies the distance between the text and the right edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rightMargin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightMargin

void setRightMargin(double rightMargin)
                    throws IOException,
                           AutomationException

Value for the right margin.

Description

RightMargin specifies the distance between the text and the right edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rightMargin - The rightMargin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopMargin

double getTopMargin()
                    throws IOException,
                           AutomationException

Value for the top margin.

Description

TopMargin specifies the distance between the text and the top edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The topMargin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopMargin

void setTopMargin(double topMargin)
                  throws IOException,
                         AutomationException

Value for the top margin.

Description

TopMargin specifies the distance between the text and the top edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

topMargin - The topMargin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBottomMargin

double getBottomMargin()
                       throws IOException,
                              AutomationException

Value for the bottom margin.

Description

BottomMargin specifies the distance between the text and the bottom edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bottomMargin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBottomMargin

void setBottomMargin(double bottomMargin)
                     throws IOException,
                            AutomationException

Value for the bottom margin.

Description

BottomMargin specifies the distance between the text and the bottom edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bottomMargin - The bottomMargin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putMargins

void putMargins(double left,
                double top,
                double right,
                double bottom)
                throws IOException,
                       AutomationException

Sets the margins.

Description

PutMargins enables setting the value for all four margins, left, top, right and bottom simultaneously.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

left - The left (in)

top - The top (in)

right - The right (in)

bottom - The bottom (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryMargins

void queryMargins(double[] left,
                  double[] top,
                  double[] right,
                  double[] bottom)
                  throws IOException,
                         AutomationException

Returns the margins.

Description

QueryMargins returns the value for all four margins, left, top, right and bottom.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.