CVB.Net 14.0
Classifier Class Reference

Color classifier object. More...

Inherits INativeHandle.

Public Member Functions

void Dispose ()
 IDisposable implementation.
 
 Classifier (string fileName)
 Load a saved classifier from a file. More...
 
void Save (string fileName)
 Write the classifier to a file. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 IDisposable helper function. More...
 

Properties

IntPtr Handle [get]
 Native Color classifier handle. More...
 
bool IsDisposed [get]
 Tests if the native handle has already been disposed.
 
string Name [get, set]
 Name of the classifier. More...
 
string FileName [get]
 Name of the file from which this classifier was loaded (string.Empty if this image list was neither loaded nor saved since its construction). More...
 
- Properties inherited from INativeHandle
IntPtr Handle [get]
 The native handle of the object.
 
bool IsDisposed [get]
 Possibility to check whether the object has already been disposed of.
 

Events

NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Detailed Description

Color classifier object.

Constructor & Destructor Documentation

◆ Classifier()

Classifier ( string  fileName)

Load a saved classifier from a file.

Parameters
fileNamename of the file to be loaded
Exceptions
FileNotFoundExceptionIf the classifier file does not exist
FileLoadExceptionIf loading an existing classifier file failed
ArgumentNullExceptionIf fileName is null

Member Function Documentation

◆ Dispose()

virtual void Dispose ( bool  disposing)
protectedvirtual

IDisposable helper function.

Parameters
disposing

◆ Save()

void Save ( string  fileName)

Write the classifier to a file.

Parameters
fileName
Exceptions
ObjectDisposedExceptionIf the classifier has already been disposed
ArgumentNullExceptionwhen fileName is null


Property Documentation

◆ FileName

string FileName
get

Name of the file from which this classifier was loaded (string.Empty if this image list was neither loaded nor saved since its construction).

Exceptions
ObjectDisposedExceptionIf the classifier has already been disposed

◆ Handle

IntPtr Handle
get

Native Color classifier handle.

It is normally not necessary to work with this handle in CVB.Net. Note that using this handle in connection with the legacy CVB managed wrappers may actually be disruptive to your application.

Implements INativeHandle.

◆ Name

string Name
getset

Name of the classifier.

Exceptions
ObjectDisposedExceptionIf the classifier has already been disposed

Event Documentation

◆ ObjectDisposing

NativeHandleEventDelegate ObjectDisposing

Raised when this object is about to be disposed via the IDisposable.Dispose method.

This event is raised right before this object is disposed. The dispose itself cannot be canceled.