CVB.Net 14.0
GenApiGrid Class Reference

GenICam GenApi Grid control. More...

Inherits UserControl.

Public Member Functions

 GenApiGrid ()
 Creates the grid control.
 

Protected Member Functions

virtual void OnSelectionChanged ()
 Raises the SelectionChanged event.
 
override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Properties

MaxVisibility MaxVisibility [get, set]
 Gets/sets the maximum visibility of features to show. More...
 
NodeMap NodeMap [get, set]
 Get/sets the GenApi.NodeMap to show. More...
 
ReadOnlyCollection< NodeVisibleItems [get]
 Gets all visible Nodes in the order they are shown in the grid. More...
 
int SelectedIndex [get, set]
 Gets/sets the selected Node via its index (based on VisibleItems). More...
 
Node SelectedItem [get, set]
 Gets/sets the selected Node. More...
 
bool PollingEnabled [get, set]
 Gets/sets whether automatic feature polling is enabled. More...
 

Events

EventHandler SelectionChanged
 Raised when the selection has been changed in the grid.
 

Detailed Description

GenICam GenApi Grid control.

Member Function Documentation

◆ Dispose()

override void Dispose ( bool  disposing)
protected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

Property Documentation

◆ MaxVisibility

Gets/sets the maximum visibility of features to show.

Default is MaxVisibility.Beginner.

◆ NodeMap

NodeMap NodeMap
getset

Get/sets the GenApi.NodeMap to show.

null to show an empty grid (default).

◆ PollingEnabled

bool PollingEnabled
getset

Gets/sets whether automatic feature polling is enabled.

Default is true.

◆ SelectedIndex

int SelectedIndex
getset

Gets/sets the selected Node via its index (based on VisibleItems).

Zero based positive index of the selected node; negative for none selected.

◆ SelectedItem

Node SelectedItem
getset

Gets/sets the selected Node.

If the given Node value is present more than once in the grid, the first occurrence is selected.

null for none selected.

◆ VisibleItems

ReadOnlyCollection<Node> VisibleItems
get

Gets all visible Nodes in the order they are shown in the grid.

Nodes can be contained more than once as they may be shown in different CategoryNodes. Also the contents may change in-between two calls if the the viewport was scrolled or category were collapsed/expanded.