com.esri.arcgis.carto
Interface IDimensionStyleDisplay

All Superinterfaces:

Serializable

All Known Implementing Classes:

DimensionStyle

public interface IDimensionStyleDisplay
extends Serializable

Provides access to members that control a dimension style's display.

Description

The IDimensionStyleDisplay interface is used to control the display properties of the various parts of a dimension feature.

Remarks

The IDimensionStyleDisplay interface uses the following enumerations to indicate the drawing properties of several of a dimension feature's elements:

The esriDimensionDisplay enumeration defines four values for use with several properties:

esriDimensionDisplayBoth - Displays the Beginning and Ending element.
esriDimensionDisplayBegin - Displays only the Beginning element.
esriDimensionDisplayEnd - Displays only the Ending element.
esriDimensionDisplayNone - Turns off display of both elements.

The MarkerFit property controls a Dimension’s behavior for fitting the text and label. The esriDimensionMarkerFit enumeration defines three values:

esriDimensionMarkerFitNone - Do not attempt to fit.
esriDimensionMarkerFitTolerance - Move markers to outside of extension lines if the MarkerFitTolerance is exceeded.
esriDimensionMarkerFitText - Move markers to outside if colliding with text. This option does not apply to custom text positions.

When the markers are moved because of a fit, a line will be drawn between the markers based on the DrawLineOnFit property. The BaselineHeight property specifies the height above the selected dimension feature that new dimension featrues will be created when using the Baseline Dimension tool.

Product Availability

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

Method Summary

double	getBaselineHeight() Height of the construction for creating baseline dimensions with this style.
IMarkerSymbol	getBeginMarkerSymbol() Symbol used for the begin arrow.
int	getDimensionLineDisplay() Dimension line display of the style.
ILineSymbol	getDimensionLineSymbol() Symbol used for the dimension line.
IMarkerSymbol	getEndMarkerSymbol() Symbol used for the end arrow.
int	getExtensionLineDisplay() Extension line display of the style.
double	getExtensionLineOffset() Length of the extension line offset.
double	getExtensionLineOvershot() Length of the extension line overshot.
ILineSymbol	getExtensionLineSymbol() Symbol used for the extension lines.
int	getMarkerDisplay() Arrow display of the style.
int	getMarkerFit() Arrow fit policy of the style.
double	getMarkerFitTolerance() Arrow fit tolerance of the style.
boolean	isDrawLineOnFit() Indicates if a dimension line should be drawn between the extension lines for an inward dimension.
void	setBaselineHeight(double height) Height of the construction for creating baseline dimensions with this style.
void	setBeginMarkerSymbol(IMarkerSymbol symbol) Symbol used for the begin arrow.
void	setDimensionLineDisplay(int displayOption) Dimension line display of the style.
void	setDimensionLineSymbol(ILineSymbol symbol) Symbol used for the dimension line.
void	setDrawLineOnFit(boolean draw) Indicates if a dimension line should be drawn between the extension lines for an inward dimension.
void	setEndMarkerSymbol(IMarkerSymbol symbol) Symbol used for the end arrow.
void	setExtensionLineDisplay(int displayOption) Extension line display of the style.
void	setExtensionLineOffset(double offset) Length of the extension line offset.
void	setExtensionLineOvershot(double overshot) Length of the extension line overshot.
void	setExtensionLineSymbol(ILineSymbol symbol) Symbol used for the extension lines.
void	setMarkerDisplay(int displayOption) Arrow display of the style.
void	setMarkerFit(int fit) Arrow fit policy of the style.
void	setMarkerFitTolerance(double tolerance) Arrow fit tolerance of the style.

Method Detail

setDimensionLineSymbol

void setDimensionLineSymbol(ILineSymbol symbol)
                            throws IOException,
                                   AutomationException

Symbol used for the dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionLineSymbol

ILineSymbol getDimensionLineSymbol()
                                   throws IOException,
                                          AutomationException

Symbol used for the dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtensionLineSymbol

void setExtensionLineSymbol(ILineSymbol symbol)
                            throws IOException,
                                   AutomationException

Symbol used for the extension lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionLineSymbol

ILineSymbol getExtensionLineSymbol()
                                   throws IOException,
                                          AutomationException

Symbol used for the extension lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBeginMarkerSymbol

void setBeginMarkerSymbol(IMarkerSymbol symbol)
                          throws IOException,
                                 AutomationException

Symbol used for the begin arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBeginMarkerSymbol

IMarkerSymbol getBeginMarkerSymbol()
                                   throws IOException,
                                          AutomationException

Symbol used for the begin arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndMarkerSymbol

void setEndMarkerSymbol(IMarkerSymbol symbol)
                        throws IOException,
                               AutomationException

Symbol used for the end arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndMarkerSymbol

IMarkerSymbol getEndMarkerSymbol()
                                 throws IOException,
                                        AutomationException

Symbol used for the end arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtensionLineOvershot

void setExtensionLineOvershot(double overshot)
                              throws IOException,
                                     AutomationException

Length of the extension line overshot.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

overshot - The overshot (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionLineOvershot

double getExtensionLineOvershot()
                                throws IOException,
                                       AutomationException

Length of the extension line overshot.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The overshot

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtensionLineOffset

void setExtensionLineOffset(double offset)
                            throws IOException,
                                   AutomationException

Length of the extension line offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionLineOffset

double getExtensionLineOffset()
                              throws IOException,
                                     AutomationException

Length of the extension line offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDimensionLineDisplay

void setDimensionLineDisplay(int displayOption)
                             throws IOException,
                                    AutomationException

Dimension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

displayOption - A com.esri.arcgis.carto.esriDimensionDisplay constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionLineDisplay

int getDimensionLineDisplay()
                            throws IOException,
                                   AutomationException

Dimension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDimensionDisplay constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtensionLineDisplay

void setExtensionLineDisplay(int displayOption)
                             throws IOException,
                                    AutomationException

Extension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

displayOption - A com.esri.arcgis.carto.esriDimensionDisplay constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionLineDisplay

int getExtensionLineDisplay()
                            throws IOException,
                                   AutomationException

Extension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDimensionDisplay constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarkerDisplay

void setMarkerDisplay(int displayOption)
                      throws IOException,
                             AutomationException

Arrow display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

displayOption - A com.esri.arcgis.carto.esriDimensionDisplay constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMarkerDisplay

int getMarkerDisplay()
                     throws IOException,
                            AutomationException

Arrow display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDimensionDisplay constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarkerFit

void setMarkerFit(int fit)
                  throws IOException,
                         AutomationException

Arrow fit policy of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fit - A com.esri.arcgis.carto.esriDimensionMarkerFit constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMarkerFit

int getMarkerFit()
                 throws IOException,
                        AutomationException

Arrow fit policy of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDimensionMarkerFit constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarkerFitTolerance

void setMarkerFitTolerance(double tolerance)
                           throws IOException,
                                  AutomationException

Arrow fit tolerance of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

tolerance - The tolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMarkerFitTolerance

double getMarkerFitTolerance()
                             throws IOException,
                                    AutomationException

Arrow fit tolerance of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawLineOnFit

void setDrawLineOnFit(boolean draw)
                      throws IOException,
                             AutomationException

Indicates if a dimension line should be drawn between the extension lines for an inward dimension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

draw - The draw (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawLineOnFit

boolean isDrawLineOnFit()
                        throws IOException,
                               AutomationException

Indicates if a dimension line should be drawn between the extension lines for an inward dimension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The draw

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaselineHeight

void setBaselineHeight(double height)
                       throws IOException,
                              AutomationException

Height of the construction for creating baseline dimensions with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaselineHeight

double getBaselineHeight()
                         throws IOException,
                                AutomationException

Height of the construction for creating baseline dimensions with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.