com.esri.arcgis.schematic
Interface INgCommand

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgCommandProxy, NgCommand

public interface INgCommand
extends Serializable

Provides access to members that control the command.

Description

A command is a procedure that generally triggers a specific treatment in response to an event from the application. A command can be applied to all object types and can be parameterized or not.

Schematics offers a full set of predefined commands, each with its own area of action, which means that it will apply to a given metatype only. If the execution of a given method or the chaining of a set of methods available from the esriSchematic library can be easily coded in your project instead of triggerring a predefined command, some predefined commands have no equivalent in the esriSchematic library. Here under is the list of all Schematics predefined commands:

• Commands that have no equivalent method in the esriSchematic library

CommandByPassNode, CommandCollapse, CommandCollapseTree, CommandCopy, CommandDecreaseSymbolSize, CommandDecreaseTextSize, CommandExpand, CommandExpandAll, CommandIncreaseSymbolSize, CommandIncreaseTextSize, CommandSeparateOverlappingLink, CommandTogglePropertyState, CommandPopupMenu

• Commands that can be directly replaced in a code program by an existing method of the esriSchematic library

CommandCenterObject, CommandCloseDiagram, CommandCloseSession, CommandDigitConnectedLink, CommandDigitLink, CommandDigitNode, CommandFit, CommandFitAll, CommandLegend, CommandLoadAndDisplayElement, CommandNewView, CommandSelectFromSchematic, CommandSelectInSchematic, CommandOnLegendEntry, CommandOpenDiagram, CommandOpenDiagramForm, CommandPrint, CommandRefreshDiagram, CommandRefreshElement, CommandRepaint, CommandInitialPosition, CommandSaveDiagram, CommandSaveSession, CommandSelectElement, CommandSetDigitMode, CommandSetEditAndMoveMode, CommandSetPanMode, CommandSetPropertyState, CommandSetSelectMode, CommandSetZoomInMode, CommandSetZoomOutMode, CommandTileWindows, CommandUndisplayObject, CommandUnselectAll

• Commands that can be easily replaced in your program code by a user procedure calling a set of existing methods available from the esriSchematic library

CommandHorizontalAlignment, CommandRemoveLinkPoints, CommandRemoveElement, CommandRotate, CommandSelectTree, CommandSymmetry, CommandVerticalAlignment

• Miscellaneous Commands

CommandContainer, CommandDelegate, CommandDelegateSubType, CommandExecuteProcedure, CommandOnAllViews, CommandUser

Product Availability

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

See Also:

INgBehavior

Method Summary

void	execute() Executes the command.
String	getName() Name of the command.
String	getParameter() Parameters for the command.
String	getStatusText() Status bar description for the command.
String	getToolTipText() Description of the command in the button-related tootip.
boolean	isChecked() Indicates if the command has been executed.
boolean	isEnabled() Indicates if the command is enabled.
void	setName(String pVal) Name of the command.
void	setParameter(String pVal) Parameters for the command.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the command.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the command.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameter

String getParameter()
                    throws IOException,
                           AutomationException

Parameters for the command.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameter

void setParameter(String pVal)
                  throws IOException,
                         AutomationException

Parameters for the command.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatusText

String getStatusText()
                     throws IOException,
                            AutomationException

Status bar description for the command.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolTipText

String getToolTipText()
                      throws IOException,
                             AutomationException

Description of the command in the button-related tootip.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

void execute()
             throws IOException,
                    AutomationException

Executes the command.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChecked

boolean isChecked()
                  throws IOException,
                         AutomationException

Indicates if the command has been executed.

Product Availability

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

Returns:

The ret

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgBehavior

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the command is enabled.

Product Availability

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

Returns:

The ret

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.