LImageViewerCell::SetDefaultWindowLevelValues

#include "ltwrappr.h"

L_INT LImageViewerCell::SetDefaultWindowLevelValues(nSubCellIndex, nWidth, nCenter, uFlags)

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_INT nWidth;

/* window level width */

L_INT nCenter;

/* window level center */

L_UINT uFlags;

/* reserved for future use */

Stores the window level default values.

Parameter

Description

nSubCellIndex

A zero-based index into the image list attached to the cell. This image will have its default window level values stored. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

nWidth

Value that represents the window level width that will be set as a default value.

nCenter

Value that represents the window level center that will be set as a default value.

uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

 

Value

Meaning

 

CELL_APPLYTOTHIS

[0x00000000] Apply the feature to this cell only.

 

CELL_APPLYTOALL

[0x10000000] Apply the feature to all the cells in the Image Viewer.

 

CELL_APPLYTOSELECTED

[0x20000000] Apply the feature to the selected cells in the Image Viewer.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function will not set the current window level values, meaning that the user will not see a change in the image. To set the current window level values call LImageViewerCell::SetActionProperties. To get the current window level values call LImageViewerCell::GetActionProperties.

This function will not set the current window level values; it will set the default ones. The default can be set using either this function, or can be internally calculated when the images are first set in the control using either LImageViewerCell::SetCellBitmapList, or through LImageViewerCell::SetRequestedImage when the low memory usage feature is enabled (for more information see the LImageViewerCell::EnableCellLowMemoryUsage function).

To reset the window level values to the default values use the LImageViewerCell::ResetWindowLevelValues function.

Required DLLs and Libraries

LTIVW

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LImageViewerCell::ResetWindowLevelValues, LImageViewerCell::GetDefaultWindowLevelValues, LImageViewerCell::GetActionProperties, LImageViewer::Create, LImageViewer::Destroy, LImageViewerCell::EnableCellLowMemoryUsage, LImageViewer::InsertCell, LImageViewerCell::SetRequestedImage, LImageViewerCell::LowMemoryUsageCallBack, LImageViewerCell::SetCellBitmapList

Topics:

Applying Actions

 

Window Control/Image Viewer Functions: Applying Actions

Example

For an example, refer to LImageViewerCell::GetDefaultWindowLevelValues.