com.esri.arcgis.display
Interface ISymbologyEnvironment

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISymbologyEnvironment2

All Known Implementing Classes:

SymbologyEnvironment

public interface ISymbologyEnvironment
extends Serializable

Provides access to members that control the environment for certain Symbol operations.

Superseded By

ISymbologyEnvironment2

Description

The ISymbologyEnvironment controls certain details of how symbols are drawn as Graphical Device Interface (GDI) objects. Most developers will find it unnecessary to change the default SymbologyEnvironment properties, as the coclass is used primarily by ArcMap to set symbology options for exporting and printing.

Product Availability

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

Method Summary

boolean	isGeometryClipping() Indicates if all geometry is clipped on output.
boolean	isOutputGDICommentForCMYKColor() Indicates if a GDI comment is output for CMYK colors.
boolean	isOutputGDICommentForGroupings() Indicates if a GDI comment is output for groupings.
boolean	isOutputGDICommentForLayers() Indicates if a GDI comment is output for layers.
boolean	isOutputGDICommentForText() Indicates if a GDI comment is output for text.
boolean	isStrokeTrueTypeMarkers() Indicates if TrueType markers are stroked.
void	setGeometryClipping(boolean geometryClipping) Indicates if all geometry is clipped on output.
void	setOutputGDICommentForCMYKColor(boolean pCmykColor) Indicates if a GDI comment is output for CMYK colors.
void	setOutputGDICommentForGroupings(boolean grouping) Indicates if a GDI comment is output for groupings.
void	setOutputGDICommentForLayers(boolean layers) Indicates if a GDI comment is output for layers.
void	setOutputGDICommentForText(boolean text) Indicates if a GDI comment is output for text.
void	setStrokeTrueTypeMarkers(boolean strokeTrueTypeMarkers) Indicates if TrueType markers are stroked.

Method Detail

isOutputGDICommentForCMYKColor

boolean isOutputGDICommentForCMYKColor()
                                       throws IOException,
                                              AutomationException

Indicates if a GDI comment is output for CMYK colors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pCmykColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForCMYKColor

void setOutputGDICommentForCMYKColor(boolean pCmykColor)
                                     throws IOException,
                                            AutomationException

Indicates if a GDI comment is output for CMYK colors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pCmykColor - The pCmykColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForLayers

boolean isOutputGDICommentForLayers()
                                    throws IOException,
                                           AutomationException

Indicates if a GDI comment is output for layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The layers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForLayers

void setOutputGDICommentForLayers(boolean layers)
                                  throws IOException,
                                         AutomationException

Indicates if a GDI comment is output for layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layers - The layers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForGroupings

boolean isOutputGDICommentForGroupings()
                                       throws IOException,
                                              AutomationException

Indicates if a GDI comment is output for groupings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The grouping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForGroupings

void setOutputGDICommentForGroupings(boolean grouping)
                                     throws IOException,
                                            AutomationException

Indicates if a GDI comment is output for groupings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

grouping - The grouping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForText

boolean isOutputGDICommentForText()
                                  throws IOException,
                                         AutomationException

Indicates if a GDI comment is output for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForText

void setOutputGDICommentForText(boolean text)
                                throws IOException,
                                       AutomationException

Indicates if a GDI comment is output for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGeometryClipping

boolean isGeometryClipping()
                           throws IOException,
                                  AutomationException

Indicates if all geometry is clipped on output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The geometryClipping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryClipping

void setGeometryClipping(boolean geometryClipping)
                         throws IOException,
                                AutomationException

Indicates if all geometry is clipped on output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

geometryClipping - The geometryClipping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStrokeTrueTypeMarkers

boolean isStrokeTrueTypeMarkers()
                                throws IOException,
                                       AutomationException

Indicates if TrueType markers are stroked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The strokeTrueTypeMarkers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStrokeTrueTypeMarkers

void setStrokeTrueTypeMarkers(boolean strokeTrueTypeMarkers)
                              throws IOException,
                                     AutomationException

Indicates if TrueType markers are stroked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

strokeTrueTypeMarkers - The strokeTrueTypeMarkers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.