com.esri.arcgis.trackinganalyst
Interface IActionEdit

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActionBase, DataModificationAction, DataPartitionAction, DataSummaryAction, EmailAlertAction, FilterAction, HighlightSuppressionAction, IActionEditProxy, TagAction

public interface IActionEdit
extends Serializable

Provides access to the methods and properties needed to edit the properties of an action.

Description

This interface provides a common set of methods for the Action Processor Editor framework to edit actions, edit the action processor, and create new actions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

void	defaultAction() Sets the action to its default state and resets existing edits.
void	edit(int hParentWindowHandle, ISet piObjectSet) Invokes Edit dialog.
int	getHelpContextID(int lControlID) The help context ID for the specified control on the page.
String	getHelpFile() The help file name for the page.
int	getPreviewImage() Preview bitmap for the renderer that appears on the page.
void	setReadOnly(boolean rhs1) Indicates whether the action is specified as read-only.

Method Detail

defaultAction

void defaultAction()
                   throws IOException,
                          AutomationException

Sets the action to its default state and resets existing edits.

Description

This method sets the action to its default state and clears or resets any existing edits.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

void edit(int hParentWindowHandle,
          ISet piObjectSet)
          throws IOException,
                 AutomationException

Invokes Edit dialog.

Description

This method invokes the editing dialog. The developer must ensure that the dialog is a modal dialog. The parent window handle is provided in order for the proper modal association to be set up. piObjectSet is the object set that needs to be edited.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

hParentWindowHandle - The hParentWindowHandle (in)

piObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreviewImage

int getPreviewImage()
                    throws IOException,
                           AutomationException

Preview bitmap for the renderer that appears on the page.

Description

This property allows you to preview a bitmap for the renderer that appears on the page.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The phBitmap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException

The help file name for the page.

Description

This property controls the help file name for the page.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pbstrHelpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

int getHelpContextID(int lControlID)
                     throws IOException,
                            AutomationException

The help context ID for the specified control on the page.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

lControlID - The lControlID (in)

Returns:

The plHelpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReadOnly

void setReadOnly(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates whether the action is specified as read-only.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.