CogImageFile Class

Cognex VisionPro 9.7

Object supporting access to image files.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.ImageFile CogImageFile

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogImageFile : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection

[SerializableAttribute]
public class CogImageFile : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection

<SerializableAttribute>
Public Class CogImageFile 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICollection

<SerializableAttribute>
Public Class CogImageFile 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICollection

[SerializableAttribute]
public ref class CogImageFile : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection

[SerializableAttribute]
public ref class CogImageFile : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection

The CogImageFile type exposes the following members.

Constructors

	Name	Description
	CogImageFile	Constructs a new instance of this class.
	CogImageFile(IntPtr)	Constructs a new instance of this class using com pointer.
	CogImageFile(CogImageFile)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	Append	Append image to end of file.
	Clone	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
	Close	Close an open image file.
	CopyTo	Copies the contents of this collection to an array.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Delete	Delete the specified images from the current open file.
	DeleteImage	Delete the specified image from the current open file.
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	(Overrides Object Finalize .)
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	Open	Open an image file.
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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.
	SuspendChangedEvent	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.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfCount	This bit will be set in the EventArgs of a Changed event every time the value returned by Count may have changed.
	SfFileName	This bit will be set in the EventArgs of a Changed event every time the value returned by FileName may have changed.
	SfOpenMode	This bit will be set in the EventArgs of a Changed event every time the value returned by OpenMode may have changed.
	SfProvider	This bit will be set in the EventArgs of a Changed event every time the value returned by Provider may have changed.

Top

Properties

	Name	Description
	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.
	Count	Gets the number of items contained in this collection.
	FileName	Name of last opened file.
	FilterText	A string suitable for displaying in a CommonDialog Control.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	IsSynchronized	Gets a value indicating whether access to this collection is synchronized (thread-safe).
	Item	Gets the item at the specified index. In C#, this property is the indexer for the collection.
	OpenMode	Mode in which the file was opened.
	Provider	The image file provider for the current open file or 0 if there is no file open.
	SupportedFileTypes	File extensions of image file types that are supported.
	SyncRoot	Gets an object that can be used to synchronize access to this collection.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.

Top

Remarks

The CogImageFile supports generic access to image files using any of the registered image file providers.

If you know the image file format ahead of time or if you need specific image file functionality, you can use the appropriate image file provider interface, rather than CogImageFile.