CogCreateGraphicLabelTool ClassCognex VisionPro 9.5
Tool that creates a graphic label.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    System.ComponentModel Component
      Cognex.VisionPro.Implementation CogComponentBase
        Cognex.VisionPro.Implementation CogSerializableComponentBase
          Cognex.VisionPro.Implementation CogSerializableChangedEventComponentBase
            Cognex.VisionPro.Implementation CogToolBase
              Cognex.VisionPro.Dimensioning CogCreateGraphicLabelTool

Namespace: Cognex.VisionPro.Dimensioning
Assembly: Cognex.VisionPro.Dimensioning (in Cognex.VisionPro.Dimensioning.dll) Version: 69.0.0.0
Syntax

[SerializableAttribute]
public class CogCreateGraphicLabelTool : CogToolBase

The CogCreateGraphicLabelTool type exposes the following members.

Constructors

  NameDescription
Public methodCogCreateGraphicLabelTool 
Constructs a new instance of this class.
Public methodCogCreateGraphicLabelTool(CogCreateGraphicLabelTool)
Constructs a new instance of this class as a deep copy of the given instance.
Protected methodCogCreateGraphicLabelTool(SerializationInfo, StreamingContext)
Top
Methods

  NameDescription
Protected methodCheckRunConditions
Check for run conditions including data binding.
(Inherited from CogToolBase.)
Protected methodCheckRunConditionsNoThrow
Check for run conditions including data binding, returning an exception for the first problem encountered.
(Inherited from CogToolBase.)
Public methodClone
Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject.
(Overrides CogToolBase Clone .)
Public methodCreateCurrentRecord
Creates a new set of records that represents the tool's current state.
(Inherited from CogToolBase.)
Public methodCreateLastRunRecord
Creates a new set of records that represents the tool's last-run state.
(Inherited from CogToolBase.)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose 
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Inherited from Component.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Protected methodGenerateFormattedText
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableComponentBase.)
Public methodGetOutputGraphicLabel
Returns a copy of the grapic label generated by the tool.
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodInternalCreateCurrentRecord (Overrides CogToolBase InternalCreateCurrentRecord(ICogRecord, Int32).)
Protected methodInternalCreateLastRunRecord (Overrides CogToolBase InternalCreateLastRunRecord(ICogRecord, Int32, Int32).)
Protected methodInternalRun (Overrides CogToolBase InternalRun(String ).)
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnChanged(Int64)
This method should be called internally whenever the object's state may have changed.
(Inherited from CogSerializableChangedEventComponentBase.)
Protected methodOnChanged(CogChangedEventArgs)
This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventComponentBase.)
Public methodOnDeserialization (Inherited from CogToolBase.)
Protected methodOnRan
Raises the Ran event.
(Inherited from CogToolBase.)
Protected methodOnRunning
Raises the Running event.
(Inherited from CogToolBase.)
Public methodResumeAndRaiseChangedEvent
Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventComponentBase.)
Public methodRun
Runs the tool. This method is guaranteed to not throw an exception. Any exception generated in the course of running the tool will be caught and packaged in the tool's RunStatus.Exception. Should this occur, the tool's RunStatus.Result will be set to Error and its RunStatus.Message will reference the message that accompanied the exception. It is the user's responsibility to examine the tool's RunStatus after calling Run.
(Inherited from CogToolBase.)
Protected methodSetRunStatus
Cognex Internal use only.
(Inherited from CogToolBase.)
Public methodSuspendChangedEvent
Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventComponentBase.)
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Top
Fields

  NameDescription
Protected fieldCurrentRecordEnable_
Gets or sets the flags specifying the records to include based on the tool's current state. The derived class exposes this as a strongly- typed enum property.
(Inherited from CogToolBase.)
Protected fieldLastRunLastRunRecordDiagEnable_
Gets or sets the flags specifying the records to create during the next invocation of the Run method.
(Inherited from CogToolBase.)
Protected fieldLastRunRecordDiagEnable_
Gets or sets the flags specifying the diagnostics records to include based on the tool's last-run state. The derived class exposes this as a strongly-typed enum property.
(Inherited from CogToolBase.)
Protected fieldLastRunRecordEnable_
Gets or sets the flags specifying the records to include based on the tool's last-run state. The derived class exposes this as a strongly- typed enum property.
(Inherited from CogToolBase.)
Protected fieldProcessingTimeAdjustment_
Gets or sets the amount to offset reported tool processing time.
(Inherited from CogToolBase.)
Public fieldStatic memberSfCurrentRecordEnable
This bit will be set in the EventArgs of a Changed event every time the value returned by CurrentRecordEnablemay have changed.
Public fieldStatic memberSfGetOutputGraphicLabel
This bit will be set in the EventArgs of a Changed event everty time the value returned by GetOutputGraphicLabelmay have changed.
Public fieldStatic memberSfInputBoolean
This bit will be set in the EventArgs of a Changed event every time the value returned by InputBoolean may have changed.
Public fieldStatic memberSfInputDouble
This bit will be set in the EventArgs of a Changed event every time the value returned by InputDouble may have changed.
Public fieldStatic memberSfInputGraphicLabel
This bit will be set in the EventArgs of a Changed event every time the value returned by InputGraphicLabelmay have changed.
Public fieldStatic memberSfInputImage
This bit will be set in the EventArgs of a Changed event every time the value returned by InputImagemay have changed.
Public fieldStatic memberSfInputInteger
This bit will be set in the EventArgs of a Changed event every time the value returned by InputInteger may have changed.
Public fieldStatic memberSfInputToolResultConstant
This bit will be set in the EventArgs of a Changed event every time the value returned by InputToolResultConstant may have changed.
Public fieldStatic memberSfLastRunRecordDiagEnable
This bit will be set in the EventArgs of a Changed event every time the value returned by LastRunRecordDiagEnablemay have changed.
Public fieldStatic memberSfLastRunRecordEnable
This bit will be set in the EventArgs of a Changed event every time the value returned by LastRunRecordEnablemay have changed.
Protected fieldStatic memberSfNetxSf
Public fieldStatic memberSfOutputColor
This bit will be set in the EventArgs of a Changed event every time the value returned by OutputColor may have been changed.
Public fieldStatic memberSfSourceSelector
This bit will be set in the EventArgs of a Changed event every time the value returned by SourceSelector may have changed.
Top
Properties

  NameDescription
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Public propertyChangedEventSuspended
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.)
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyCurrentRecordEnable
Enable creation of records by bitwise ORing the appropriate CogCreateGraphicLabelCurrentRecordConstants.
Public propertyDataBindings
Gets the data bindings for the tool.
(Inherited from CogToolBase.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyFailOnInvalidDataBinding
Specifies that the Run method is to fail if executed while one or more data bindings are invalid.
(Inherited from CogToolBase.)
Public propertyHasChanged (Inherited from CogSerializableChangedEventComponentBase.)
Public propertyInputBoolean
Returns or sets the input boolean value.
Public propertyInputDouble
Returns or sets the input double value.
Public propertyInputGraphicLabel
Returns or sets the input graphic label.
Public propertyInputImage
Returns or sets the input image.
Public propertyInputInteger
Returns or sets the input integer value.
Public propertyInputToolResultConstant
Public propertyLastRunRecordDiagEnable
Enable creation of records by bitwise ORing the appropriate CogCreateGraphicLabelLastRunRecordDiagConstants.
Public propertyLastRunRecordEnable
Enable creation of records by bitwise ORing the appropriate CogCreateGraphicLabelLastRunRecordConstants.
Public propertyName
Gets or sets a user-supplied name for the tool.
(Inherited from CogToolBase.)
Public propertyOutputColor
Returns or sets the color of the output graphic label.
Public propertyRunStatus
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.)
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertySourceSelector
Returns or sets the source selector.
Public propertyStateFlags
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.)
Public propertyUserData
Gets a CogDictionary object that can be used to store application-specific information.
(Inherited from CogToolBase.)
Top
Events

  NameDescription
Public eventChanged
This event is raised when one or more parts of the object's state may have changed.
(Inherited from CogSerializableChangedEventComponentBase.)
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose  method.
(Inherited from Component.)
Public eventRan
Event that is raised at the end of the tool's Run method.
(Inherited from CogToolBase.)
Public eventRunning
Event that is raised at the start of the tool's Run method.
(Inherited from CogToolBase.)
Top
Remarks

This class provides a tool wrapper for CogGraphicLabel. This is intended to facilitate use in QuickBuild. Do not use this class programmatically - instead use CogGraphicLabel directly.
See Also