Feedback

  • Contents
 

II3IDStep Interface

Overview

Derived From:        IDispatch

Refined By:            II3IDStep2

Interface ID:          {EA40400E-AF19-46F8-9DCF-4888A7A01A5E}

A step is an actual instance of a tool, subroutine or initiator within a handler.  To determine what it is an instance of, get its step type and then request the step's SourceTool, SourceInitiator or SourceSubroutine properties.

Methods

ClearInfoStr

Clears the info string associated with this step.

LogMessage

Logs a message for the step in Interaction Designer's messages collection.

ResizeToFitLabel

Resizes a step so that the label text will fit.

Validate

This method returns NULL (or Nothing) if the node is publishable.  If the node is not publishable, it returns a collection of II3IDMessages validation messages.

Properties

Bottom

Returns the bottom pixel location of this step in the handler.

Designer

Returns an Interaction Designer interface pointer.

ExitPaths

Returns a collection of the exit paths leaving this step or initiator.

Handler

Returns the handler object that contains this step.

Height

Returns the height of the node in pixels.

ID

Returns the Step ID number associated with this step.

InfoStr

Returns the information string for the step.  This string is passed out to the DLL that registers for the IntermediatePublish callback when EICPublisher is launched.

InitNotificationEvent

Returns the currently assigned notification event if the step type is an initiator.   If the step is not an initiator, an empty string is returned.

InitObjectID

Returns the initiator's object ID if the step type is an initiator.

Label

Returns the label associated with this step.

Left

Returns the x-coordinate (left) pixel location of this step in the handler document.

NextSteps

Returns a collection of all steps that this step can branch to.

Notes

Returns the description associated with this step.

Parameters

Returns a collection of parameters that are instantiated for this step. You may optionally use this property to return parameters for an internal subroutine step.

PreviousSteps

Returns an II3IDStepLinks collection of all steps that can branch to this step.

Right

Returns the rightmost pixel of this step as it is rendered within the handler document.

SourceInitiator

Returns the initiator object used to create this step.

SourceSubroutine

Return a subroutine object that wraps the subroutine used to create this step.

SourceTool

Return the tool object used to create this step.

StepType

Returns the step type (Tool, Subroutine, Initiator, etc.) of this step.  If the step type is a Tool, you can call get_SourceTool to retrieve the tool object that created this tool step.  Similar handling can be used for Initiators and Subroutines.

Top

Returns the y-coordinate (top) pixel location of this step in the handler document.

Width

Returns the width of this step as it is rendered within the handler document.

XML

Retrieves XML step and variable information from a handler.