com.esri.arcgis.display
Interface ISimpleMarkerSymbol

All Superinterfaces:
IMarkerSymbol, Serializable
All Known Implementing Classes:
SimpleMarkerSymbol

public interface ISimpleMarkerSymbol
extends IMarkerSymbol, Serializable

Provides access to members that control the simple marker symbol.

Description

ISimpleMarkerSymbol is used to create a marker symbol comprised of a predefinded set of styles. The availble styles are provided by the esriSimpleMarkerStyle enumeration. Optionally, an Outline may be placed around the outside edge of the symbol. Use the IMarkerSymbol interface to set additional properties for ISimpleMarkerSymbols.

Product Availability

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


Method Summary
 IColor getOutlineColor()
          Outline color.
 double getOutlineSize()
          Outline diameter.
 int getStyle()
          Marker style.
 boolean isOutline()
          Indicates if the symbol outline will draw.
 void setOutline(boolean outline)
          Indicates if the symbol outline will draw.
 void setOutlineColor(IColor outlineColor)
          Outline color.
 void setOutlineSize(double size)
          Outline diameter.
 void setStyle(int style)
          Marker style.
 
Methods inherited from interface com.esri.arcgis.display.IMarkerSymbol
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 

Method Detail

getStyle

int getStyle()
             throws IOException,
                    AutomationException
Marker style.

Description

Style is the enumeration that controls the pattern used as the marker. The avaialble line options include: esriSMSCircle, esriSMSCross, esriSMSDiamond, esriSMSSquare and esriSMSX. esriSMSCircle is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStyle

void setStyle(int style)
              throws IOException,
                     AutomationException
Marker style.

Description

Style is the enumeration that controls the pattern used as the marker. The avaialble line options include: esriSMSCircle, esriSMSCross, esriSMSDiamond, esriSMSSquare and esriSMSX. esriSMSCircle is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isOutline

boolean isOutline()
                  throws IOException,
                         AutomationException
Indicates if the symbol outline will draw.

Description

Boolean indicator to draw an outline around the marker. False is the default Outline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOutline

void setOutline(boolean outline)
                throws IOException,
                       AutomationException
Indicates if the symbol outline will draw.

Description

Boolean indicator to draw an outline around the marker. False is the default Outline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOutlineSize

double getOutlineSize()
                      throws IOException,
                             AutomationException
Outline diameter.

Description

OutlineSize is the width of the outline in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOutlineSize

void setOutlineSize(double size)
                    throws IOException,
                           AutomationException
Outline diameter.

Description

OutlineSize is the width of the outline in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOutlineColor

IColor getOutlineColor()
                       throws IOException,
                              AutomationException
Outline color.

Description

Color is the color for the outline. Any IColor object can be used.

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.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutlineColor

void setOutlineColor(IColor outlineColor)
                     throws IOException,
                            AutomationException
Outline color.

Description

Color is the color for the outline. Any IColor object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
outlineColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.