II3IDStepEvents::EditStepProperties Method

Synopsis

This step event is called when a request is made to open the properties dialog for a step. This makes it possible to display a custom property dialog.

IDL Function Prototype

HRESULT EditStepProperties(

   [in] II3IDStep * StepToModify,

   [in] long ParentHWND,

   [out, retval] VARIANT_BOOL * BeenHandled

);

C/C++ Syntax

HRESULT EditStepProperties(II3IDStep * StepToModify, long ParentHWND, VARIANT_BOOL * BeenHandled);

Parameters

StepToModify

The II3IDStep object whose properties will be edited.

ParentHWND

The handle of the parent window.

BeenHandled

The return value is a Boolean flag that indicates whether or not the callback that has been called by Interaction Designer has handled this event. When this value is True, Interaction Designer does not need to perform it's default event processing.

When BeenHandled is False, Interaction Designer displays the standard Edit Properties dialog. When BeenHandled is set to True by the callout, Interaction Designer does not attempt display a dialog to the user, since it is assumed that the callback has already displayed an edit properties dialog for the user.