CogOCRMaxCharKey ClassCognex VisionPro 9.7
The CogOCRMaxChar class holds an object of type CogOCRMaxCharKey in its Key property. The Key contains information that identifies the CogOCRMaxChar. Most importantly the Key property holds the CharacterCode. The CharacterCode is a Unicode UTF-32 value which determines the 'letter' a CogOCRMaxChar corresponds to.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.OCRMax CogOCRMaxCharKey

Namespace: Cognex.VisionPro.OCRMax
Assembly: Cognex.VisionPro.OCRMax (in Cognex.VisionPro.OCRMax.dll) Version: 73.0.0.0
Syntax

[SerializableAttribute]
public class CogOCRMaxCharKey : CogSerializableObjectBase

The CogOCRMaxCharKey type exposes the following members.

Constructors

  NameDescription
Public methodCogOCRMaxCharKey 
Construct a default CogOCRMaxCharKey object.
Public methodCogOCRMaxCharKey(CogOCRMaxCharKey)
Constructs a deep copy of the supplied CogOCRMaxCharKey object.
Protected methodCogOCRMaxCharKey(SerializationInfo, StreamingContext)
Serialization constructor for CogOCRMaxCharKey.
Public methodCogOCRMaxCharKey(Int32, Int32, Int32, Int32)
Construct a new CogOCRMaxCharKey and intialize its properties using the arguments provided.
Top
Methods

  NameDescription
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 methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodEqualTo
Returns true if other has the same character code, instance number, font ID, and variant.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
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 CogSerializableObjectBase.)
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetString 
Returns a string which represents this CogOCRMaxCharKey.
Public methodGetString(String)
Returns a string which represents this CogOCRMaxCharKey.
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 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.)
Public methodToString
Returns string data about this CogOCRMaxCharKey.
(Overrides Object ToString .)
Top
Properties

  NameDescription
Public propertyCharacterCode
The character code, which is a Unicode UTF-32 code point.
Public propertyFontID
This is the ID of the font (i.e. set of characters) of which character is a member. One potential use for this value would be to have each font use a distinct value for the characters in that font, so that an application could refer to a set of character keys from all the fonts and still be able to distinguish which character came from which font.
Public propertyInstance
The instance number, which can be used to uniquely identify a particular instance of a character with a given character code within a particular font.
Public propertyVariant
The variant number, which can be used to indicate a distinct appearance of a character code. For example, a particular font might contain two visually distinct appearances for the digit zero "0", one of which might simply be an ellipse and another that is an ellipse with a diagonal stroke through it.
Top
Remarks

Adding a CogOCRMaxChar to a CogOCRMaxFont will cause the CogOCRMaxChar.Key to be automatically replaced by a new CogOCRMaxCharKey to ensure that the Key's Instance number is unique.

See Also