The CogUserTool type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AbortRunOnToolFailure |
Gets or sets a flag indicating if the Run invocation should abort if
the Run method of any of its contained tools fails.
|
 | AllTools |
All the Tools owned by this user tool, includes tools
that aren't part of the main tools collection but are
still tools owned by this user tool... like ToolBlock
Inputs and Outputs.
|
| CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
| ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventComponentBase.) |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| DataBindings |
Gets the data bindings for the tool.
(Inherited from CogToolBase.) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| DisabledTools |
Gets the collection of tools that are omitted from those run by this
user tool.
|
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| ExtraTools |
Tools that aren't part of the main tools collection
but are still tools owned by this user tool... like
ToolBlock Inputs and Outputs. These tools may or
may not show up in main ToolTreeView.
|
| FailOnInvalidDataBinding |
Specifies that the Run method is to fail if executed while one or more
data bindings are invalid.
(Inherited from CogToolBase.) |
| HasChanged | (Inherited from CogSerializableChangedEventComponentBase.) |
| LastRunRecordEnable |
Enable creation of records by bitwise ORing the
appropriate CogUserToolLastRunRecordConstants.
|
| Name |
Gets or sets a user-supplied name for the tool.
(Inherited from CogToolBase.) |
| RunStatus |
Gets general information about the last call to the tool's
Run function. Note that serious errors that occur within
the tool's Run method may only be detected by examining the
RunStatus after calling Run. It is the user's responsibility
to examine the tool's RunStatus after calling Run.
(Inherited from CogToolBase.) |
| Script |
Cognex Internal Use Only.
|
| ScriptError |
Cognex Internal Use Only.
|
| Site | Gets or sets the ISite of the Component. (Inherited from Component.) |
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventComponentBase.) |
| Tools |
Gets the collection of tools within this user tool.
|
| UserData |
Gets a CogDictionary object that can be used to store application-specific information.
(Inherited from CogToolBase.) |
See Also