CVB.Net 14.0
SampleImageList.ImageLabelInfo< TLabel > Struct Template Reference

Base class for providing SIL label information. More...

Inherits SampleList.ILabelInfo< TLabel >, and SampleList.ISampleListChild.

Properties

ImageCollection Samples [get]
 Samples under this label. More...
 
int Index [get]
 Get the index of this label. Note that this index may change when samples are removed from the image list - therefore you should check this index often. Generally it is more recommendable to work label based, not index based. More...
 
TLabel Label [get]
 Label under which this class is stored. You may change this label using the Relabel method. More...
 
Type LabelType [get]
 Type of the labels.
 
SampleList ParentList [get]
 SampleList object to which this class file object is bound
 
- Properties inherited from SampleList.ILabelInfo< TLabel >
int Index [get]
 Numeric index of the label.
 
Type LabelType [get]
 Type of the label (either typeof(string) or typeof(float[])).
 
- Properties inherited from SampleList.ISampleListChild
SampleList ParentList [get]
 Object through which the native handle may be accessed.
 

Additional Inherited Members

void Relabel (TLabel newLabel)
 Change the label of a class. More...
 

Detailed Description

Base class for providing SIL label information.

Template Parameters
TLabelLabel type.

Property Documentation

◆ Index

int Index
get

Get the index of this label. Note that this index may change when samples are removed from the image list - therefore you should check this index often. Generally it is more recommendable to work label based, not index based.

Exceptions
ObjectDisposedExceptionIf the parent list has already been disposed.

Implements SampleList.ILabelInfo< TLabel >.

◆ Label

TLabel Label
get

Label under which this class is stored. You may change this label using the Relabel method.

Exceptions
ObjectDisposedExceptionIf the parent list has already been disposed.

◆ Samples

ImageCollection Samples
get

Samples under this label.

Exceptions
ObjectDisposedExceptionIf the parent list has already been disposed.