The VBPromotedAction statement describes the implementation
and interface of an action that is promoted to the interface of a
composite part. The VBAction statement describes only the
interface of a promoted action. In addition to the information
specified for a VBAction statement, the VBPromotedAction
statement identifies the source of the promoted action. Use this
statement to describe promoted actions.
{ //VBPromotedAction: name, description?,
vbReturnType?, signature, subpartName,
subpartFeatureName, featureFlag* }
-
- name
- Action name to be used in visual composition.
- description
- Optional feature description.
( "text
description" | (resourceId, resourceDll)
)
-
- resourceId
- Optional resource number of the descriptive text.
If you specify a resource ID, you must also
specify the resource DLL name.
- resourceDll
- Optional resource DLL name containing the
descriptive text. You must specify the DLL name
if you specify a resource ID. Do not include the
.dll extension.
- vbReturnType
- Optional return type that specifies the type of the
return value from the action and allows the user to make
connections to this value. Connections are available
through the actionResult event. The return type
must be compatible with the return type in the action
member function signature.
- signature
- For a visual, nonvisual, or class interface part, the
signature of the C++ public member function that
implements the action. For a function group part, the
signature of the C function that implements the action.
The parameter names are used in the Composition Editor to
name parameter connections.
- subpartName
- The name of the embedded part from which the action is
promoted.
- subpartFeatureName
- The name of the action that is promoted from the the
embedded part.
- featureFlag
- Optional feature flag.
( connect |
noconnect | preferred | noWin
| noOS2 | noAIX )
-
- connect
- Allows connections to the action. If neither connect
nor noconnect is specified, connect
is assumed.
- noconnect
- Prevents connections to the action.
- preferred
- Specifies that the feature is preferred for the
part. Preferred features appear in the part
connection list.
- noWin
- Excludes the feature on Windows.
- noOS2
- Excludes the feature on OS/2.
- noAIX
- Excludes the feature on AIX.
Defining the Part
Interface Using Part Information Statements
Visual Part Information
Statements
Nonvisual Part Information
Statements
Part Information Statement
Descriptions
Part Information
Statement Examples