Contents

II3ID Interface

Overview

Derived From: IDispatch

Refined By: II3ID2

Interface ID: {450664A9-C0BB-4749-8488-906A4A575EF7}

This interface provides a gateway into Interaction Designer. It provides access to handlers, subroutines, tools, and to properties that provide general information about the Designer environment. Every interface object, except for objects in collections, has a Designer property that relates back to this interface. This provides the means to obtain underlying information at an environmental level.

Methods

CreateHandler	Creates a new handler and returns an interface pointer to the handler.
CurrentHandler	Returns a handler object to the currently active handler in Interaction Designer. Returns S_FALSE, rather than an exception if no handler is open.
EscapeString	Escapes a string sequence for usage to the II3IDParameter::put_Expression call.
GetErrorMessage	Returns the error string for the specified eIdToolRetCode value defined in the i3idTool.h file. The string returned is internationalized for the local for which Designer was compiled.
GetLicenseInfo	This method returns True if a valid license is available for the feature specified.
MessageBox	Prompts the user with a message box and returns the entry back to the caller. See the Windows SDK help documentation about Messagebox for valid values for Type parameter.
OpenHandler	Opens the specified handler and returns a handler object.
QueryNativeTypeName	Returns the name associated with an internal data type defined in Interaction Designer. For example, 'ID_String' returns 'String'.
ReadProfileLong	This method reads a numeric value from the registry. To retrieve a value, specify the name of a section and the name of an entry, as if you were reading an INI file. Use II3ID::WriteProfileLong to write an integer value to the registry.
ReadProfileString	This method reads a string value from the registry. To retrieve a value, specify the name of a section and the name of an entry, as if you were reading an INI file. Use II3ID::WriteProfileString to write a string to the registry.
RegisterForIdEvents	Register an interface pointer (i.e.II3IDEvents) to receive event notifications from Interaction Designer.
UnescapeString	Unescapes a string expression returned from II3IDParameter::get_Expression.
WriteProfileLong	This method saves a numeric value to the registry. You must specify section and entry names, and the value to save. This process is comparable to writing a value to an INI file. Use II3ID::ReadProfileLong to read an integer value from the registry.
WriteProfileString	This method saves a string value to the registry.You must specify section and entry names, and the value to save. This process is comparable to writing a value to an INI file. Use II3ID::ReadProfileString to read an integer value from the registry.

Properties

CurrentHandlerSelectedSteps	Returns an II3IDSteps collection of the currently selected steps for the handler displayed in the active window.
Handlers	This property returns all of the currently loaded handlers in Interaction Designer.
ICServer	Returns an interface pointer to the primary server Interaction Designer is connected to.
Initiators	This property returns a collection of Initiators registered in Interaction Designer.This collection represents initiators displayed to a user after the File \| Change Initiator menu operation is selected.
IsBatchPublishing	This property indicates whether or not Interaction Designer is currently batch publishing. Batch publishing is a way of publishing a group of handlers automatically rather than one at a time through Interaction Designer.
LastErrors	Retrieve the current automation error messages.
Locale	The locale that Interaction Designer is currently running in. This returns a Windows LCID (locale identifier) as the output.
MenuManager	Returns a pointer to the Interaction Designer Menu Manager. This allows you to add menu items below the Utilities menu.
ShowPublishErrorDialogs	Whether or not the user has specified the /LogPublishEvents command line switch. If so, your tool should not pop any modal dialogs for a publish and write to the event log directly.
Subroutines	Returns a collection of subroutines loaded in Interaction Designer.
Tools	Returns a collection of the currently registered tools within Interaction Designer. This can be used to query whether or not a tool is already registered.
Types	Returns a collection of data types registered in Interaction Designer.
UserName	Returns the name of the currently registered user. This user name has been verified against Notifier, either explicitly or implicitly.