com.esri.arcgis.controls
Interface IGraphicProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommandsEnvironment

public interface IGraphicProperties
extends Serializable

Provides access to members that control the CommandsEnvironment singleton.

Description

The IGraphicProperties interface controls the default symbols used by the controls commands and can be used by any custom commands you develop.

Product Availability

Available with ArcGIS Engine.

Method Summary

IFormattedTextSymbol	getCallout() The callout symbol used by the CommandsEnvironment singleton.
IFillSymbol	getFillSymbol() The fill symbol used by the CommandsEnvironment singleton.
ILineSymbol	getLineSymbol() The line symbol used by the CommandsEnvironment singleton.
IMarkerSymbol	getMarkerSymbol() The marker symbol used by the CommandsEnvironment singleton.
ITextSymbol	getTextSymbol() The text symbol used by the CommandsEnvironment singleton.
void	setCallout(IFormattedTextSymbol ppCallout) The callout symbol used by the CommandsEnvironment singleton.
void	setFillSymbol(IFillSymbol ppFillSymbol) The fill symbol used by the CommandsEnvironment singleton.
void	setLineSymbol(ILineSymbol ppLineSymbol) The line symbol used by the CommandsEnvironment singleton.
void	setMarkerSymbol(IMarkerSymbol ppMarkerSymbol) The marker symbol used by the CommandsEnvironment singleton.
void	setTextSymbol(ITextSymbol ppTextSymbol) The text symbol used by the CommandsEnvironment singleton.

Method Detail

setMarkerSymbol

void setMarkerSymbol(IMarkerSymbol ppMarkerSymbol)
                     throws IOException,
                            AutomationException

The marker symbol used by the CommandsEnvironment singleton.

Product Availability

Available with ArcGIS Engine.

Parameters:

ppMarkerSymbol - 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.

getMarkerSymbol

IMarkerSymbol getMarkerSymbol()
                              throws IOException,
                                     AutomationException

The marker symbol used by the CommandsEnvironment singleton.

Description

The MarkerSymbol used by the ControlsNewMarkerTool, ControlsRouteCommand and the IHookActions methods. By default the IMarkerSymbol::Size is 2, and the IMarkerSymbol::Color is black.

The IMarkerSymbol::Color returns a clone, so to change the default color set an IColor object into IMarkerSymbol::Color.

Product Availability

Available with ArcGIS Engine.

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.

setLineSymbol

void setLineSymbol(ILineSymbol ppLineSymbol)
                   throws IOException,
                          AutomationException

The line symbol used by the CommandsEnvironment singleton.

Product Availability

Available with ArcGIS Engine.

Parameters:

ppLineSymbol - 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.

getLineSymbol

ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException

The line symbol used by the CommandsEnvironment singleton.

Description

The LineSymbol used by the ControlsNewCurveTool, ControlsNewFreeHandTool, ControlsNewLineTool, ControlsInkGenericDrawTool, ControlsInkHighlightTool, ControlsInkPenTool and the IHookActions methods. By default the Size is 2, and the ILineSymbol::Color is black.

The ILineSymbol::Color returns a clone, so to change the default color set an IColor object into ILineSymbol::Color.

Product Availability

Available with ArcGIS Engine.

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.

setFillSymbol

void setFillSymbol(IFillSymbol ppFillSymbol)
                   throws IOException,
                          AutomationException

The fill symbol used by the CommandsEnvironment singleton.

Product Availability

Available with ArcGIS Engine.

Parameters:

ppFillSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException

The fill symbol used by the CommandsEnvironment singleton.

Description

The FillSymbol used by the ControlsNewCircleTool, ControlsNewEllipseTool, ControlsNewPolygonTool, ControlsNewRectangleTool and the IHookActions methods. By default the IFillSymbol::Color is yellow and the IFillSymbol::Outline is black with a width of 1.

The IFillSymbol::Color and IFillSymbol::Outline return clones, so to change the default color and outline set an IColor object into IFillSymbol::Color and an ILineSymbol into IFillSymbol::Outline.

Product Availability

Available with ArcGIS Engine.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbol

void setTextSymbol(ITextSymbol ppTextSymbol)
                   throws IOException,
                          AutomationException

The text symbol used by the CommandsEnvironment singleton.

Product Availability

Available with ArcGIS Engine.

Parameters:

ppTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol used by the CommandsEnvironment singleton.

Description

The TextSymbol used by the ControlsInkFinishSketchCommand, ControlsRouteCommand and the IHookActions methods. By default the TextSymbol is black, and size 10 using the 'Arial' font.

Product Availability

Available with ArcGIS Engine.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallout

void setCallout(IFormattedTextSymbol ppCallout)
                throws IOException,
                       AutomationException

The callout symbol used by the CommandsEnvironment singleton.

Product Availability

Available with ArcGIS Engine.

Parameters:

ppCallout - A reference to a com.esri.arcgis.display.IFormattedTextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCallout

IFormattedTextSymbol getCallout()
                                throws IOException,
                                       AutomationException

The callout symbol used by the CommandsEnvironment singleton.

Description

The Callout used by the IHookActions methods. By default the Callout is black, and size 10 using the 'Arial' font.

Product Availability

Available with ArcGIS Engine.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.