You are here: Start » FIL.NET » FIL.DebugPreviewShowRegion
FIL.DebugPreviewShowRegion
Shows region in separated window. When called first time creates new window with size fit to region.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
public static bool DebugPreviewShowRegion ( FilNet.DebugPreviewWindowState ioState, FilNet.Region inRegion )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
| ioState | FilNet.DebugPreviewWindowState | State object of sustained preview window. | |||
 | inRegion | FilNet.Region | Region to preview. |
Description
This function helps in debugging of FabImage Library based applications by providing a quick but primitive way to preview internal application image-oriented data in floating windows.
A preview window is bound to the state object specified in the first argument of the function. On the first call on specified state object instance, this function will create and show a new floating window with size fitted to the specified region. Every subsequent call on the same state object instance will only update the region in preview.
A preview window will be closed as a result of the following actions:
- the user closes the window using its tool box (state object remains valid),
- the state object of the window is destructed,
- DebugPreviewCloseWindow is called on the window state object,
- DebugPreviewCloseAllWindows is called.
This function creates a background thread with message pump (single thread shared by all windows in the debug preview subsystem) that will stay active till application close (even when no more windows are active). To explicitly close the debug preview subsystem and free its resources call DebugPreviewCloseAllWindows function.
Leaving the start position set to its default value (-1x-1) will automatically arrange windows, starting from top left corner of the screen.
Return value
This function returns true after successful creation or update of an active window. After such window is closed by the user, subsequent calls to this function will return false.
