Class Display
Windows Forms display control
Inheritance
Implements
Inherited Members
Namespace: ic4.WinForms
Assembly: ic4dotnet.System.Windows.Forms.dll
Syntax
public class Display : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IDisplayConstructors
Display()
Create a new display
Declaration
public Display()Properties
InternalHandle
Handle for the display (internal use only)
Declaration
[Browsable(false)]
public IntPtr InternalHandle { get; }Property Value
| Type | Description |
|---|---|
| IntPtr |
RenderHeight
The height of the target rectangle inside the display
Declaration
[Browsable(true)]
public int RenderHeight { get; set; }Property Value
| Type | Description |
|---|---|
| int | The height of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderLeft
The left coordinate of the target rectangle inside the display
Declaration
[Browsable(true)]
public int RenderLeft { get; set; }Property Value
| Type | Description |
|---|---|
| int | The left coordinate of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderPosition
The scaling and alignment mode to use
Declaration
[Browsable(true)]
public DisplayRenderPosition RenderPosition { get; set; }Property Value
| Type | Description |
|---|---|
| DisplayRenderPosition | The scaling and alignment mode to use |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderTop
The top coordinate of the target rectangle inside the display
Declaration
[Browsable(true)]
public int RenderTop { get; set; }Property Value
| Type | Description |
|---|---|
| int | The top coordinate of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderWidth
The width of the target rectangle inside the display
Declaration
[Browsable(true)]
public int RenderWidth { get; set; }Property Value
| Type | Description |
|---|---|
| int | The width of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
Statistics
Queries display statistics.
Declaration
[Browsable(false)]
public DisplayStatistics Statistics { get; }Property Value
| Type | Description |
|---|---|
| DisplayStatistics | A structure contains display statistics |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
Methods
CanRender(ImageType)
Checks whether the display can render images of a specified image type.
Declaration
public bool CanRender(ImageType imageType)Parameters
| Type | Name | Description |
|---|---|---|
| ImageType | imageType | The image type to check |
Returns
| Type | Description |
|---|---|
| bool |
|
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
DisplayBuffer(ImageBuffer)
Displays a specific image buffer.
Declaration
public void DisplayBuffer(ImageBuffer buffer)Parameters
| Type | Name | Description |
|---|---|---|
| ImageBuffer | buffer | The buffer to display |
Remarks
When buffer is null, the display is cleared and will no longer display the previous buffer.
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
OnLoad(EventArgs)
Declaration
protected override void OnLoad(EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| EventArgs | e |
Overrides
OnPaint(PaintEventArgs)
Paints the control background in design mode
Declaration
protected override void OnPaint(PaintEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| PaintEventArgs | e |
Overrides
ThrowIfCannotRender(ImageType)
Checks whether the display can render images of a specified image type.
If the image type can not be rendered, an exception is thrown.
Declaration
public void ThrowIfCannotRender(ImageType imageType)Parameters
| Type | Name | Description |
|---|---|---|
| ImageType | imageType | The image type to check |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |