Feedback

  • Contents
 

II3IDHandler Interface

Overview

Derived From:        IDispatch

Refined By:            II3IDHandler2

Interface ID:          {2354ECA7-EA5C-415E-BD70-13E4C6E17029}

II3IDHandler provides an interface that wraps a handler in Interaction Designer.

Methods

ChangeInitiator

This method changes the Initiator of the handler. An initiator is always the first step in a handler. It tells Interaction Processor which event starts an instance of that handler.

Close

Closes the handler and all associated view (windows) for the handler.

GenerateI3PUB

Generates a .i3pub file in the specified path. An .i3pub file packages information about a handler, so that the handler can be saved to disk and published later.

InsertSubroutineStep

This method inserts a subroutine step into a handler.

InsertToolStep

This method inserts a tool step into a handler.

IsEqualTo

This property indicates whether or not the inbound handler interface pointer points to the same handler.

Publish

Publishes the handler to the default IC server.

RemoveStep

Removes a step from a handler.

Save

Saves the handler.

SaveAs

Saves the handler using the filename and path specified.

SetModified

Sets the modified flag on a handler.

Validate

This method validates a handler to see if it is ready for publish. If it is not ready, the ValidationMessages parameter will contain a list of messages indicating why the handler is not ready to be published.

Properties

Category

Returns the category of this handler (applicable for handlers with subroutine initiators).

Description

Returns the description text for the handler.

Designer

Returns an Interaction Designer interface pointer.

FilePath

Returns the file path where the handler is located.

InitiatorStep

Retrieves the initiator step for this handler. An initiator step identifies the event that initiates an instance of this handler.

IsModified

Whether or not the handler has been modified.

IsPublishable

This property indicates whether or not a handler is publishable.

IsReadOnly

Returns whether the handler is read-only. Handlers that have been opened for debugging are read only.

Name

Returns the name of the handler, without path information.

Steps

Returns a collection of steps contained in this handler.

ValidationMessages

Retrieve the validation messages for the handler.

Variables

Retrieves a collection of all variables used by this handler.

XML

Retrieves XML step and variable information from a handler.