API Documentation -> NtDisplayObjectBitmap

# NtDisplayObjectBitmap

Derived from NtDisplayObject.
The NtTimeChartControl creates NtDisplayObjectBitmap objects for data objects that are declared (by the according NtDisplayDef) to be drawn as bitmaps or icons. In the image below you can find such NtDisplayObjectBitmap objects in the third row ('Creatinin') to draw icons and in the fourth row ('AMV') to draw bitmaps.
Normally the technology behind this is that the value of a data object is stored in a NtDataObject. This NtDataObject is then used to call the NtApplication.GetBitmap() or the NtApplication.GetIcon() method to ask the application about the icon or bitmap. The bitmap returned is used to create an NtDisplayObjectBitmap which is then used for drawing the data object.

The NtDisplayObjectBitmap class does not have a public constructor. It can only be created by the NtTimeChartControl.

Class Hierarchy:

System.Object

NtDisplayObject

NtDisplayObjectBitmap

Methods and Properties:

Modifier / Return Value | Name and Parameters | Description
--- | --- | ---
public NtDataObject | DataObject | Readonly property that allows you to access the embedded NtDataObject. This is helpful because several events like mouse clicking on Display Objects will hand you over their NtDisplayObjectEventArgs that reference a NtDisplayObjectBitmap. Then you typically need to get access to its embedded NtDataObject to react properly. Inherited from NtDisplayObject.
public int | CurrentRow | The zero base index of the row the NtDisplayObjectBitmap is currently in. Currently means that this might change any time due to users dragging rows and thereby change their order or the application setting a new NtPerspective. This property is readonly. Inherited from NtDisplayObject.
public int | CategoryRow | This is the row that hides this NtDisplayObjectBitmap in case of a superior category being closed: Explanation: In case that this display object is in a row which is member of a category then this category can be closed. Then the NtDisplayObjectBitmap is hidden. And instead of the object a so called category line (a thin vertical line in place of the object) is being drawn directly onto the category row. This readonly property returns the row index of the closing category if there is one. If not, it returns -1.
public Rectangle | PaintRect | This is the rectangle that comprises this NtDisplayObjectBitmap. It is given in row coordinates. This means that X=0 is the left end of the current sheet, Y=0 means top of the row it resides in. It is not an error if the paint rectangle exeeds the sheet horizontally or the row vertically. Painting will be clipped accordingly. When you do custom drawing, the NtTimeChartControl's framework will initialize this property correctly before calling your implementation of the NtCustomObjectPaint interface so you do not need to bother about coordinate transformation but can simply draw within this rectangle. Inherited from NtDisplayObject.
public int | DisplayMethod | This is the display method for this NtDisplayObjectBitmap. Please see NtDisplayDef for details. In case of custom drawn objects this property is greater than 100. Inherited from NtDisplayObject.
public NtDisplayDef | DisplayDef | The NtDisplayDef that is set for this NtDisplayObjectBitmap because it is set for the data type this NtDisplayObjectBitmap represents. Inherited from NtDisplayObject.

Members:

Type | Name | Description
--- | --- | ---
public Bitmap | bitmap | The bitmap of this NtDisplayObjectBitmap. It is null because the cross is drawn without using the bitmap. Inherited from NtDisplayObject.

Top API Documentation -> NtDisplayObjectBitmap © 2016 Bassaly