LImageViewerCell::GetCellScale

Summary

Gets the current scale value of the specified cell or sub-cell.  This feature is available in version 16 or higher.

Syntax

L_INT LImageViewerCell::GetCellScale(nSubCellIndex, pdScale, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. The scale for this sub-cell will be retrieved. This sub-cell scale will be retrieved. Pass -2 to retrieve the scale of the selected sub-cell.

L_DOUBLE * pdScale

Address of the variable to be updated with the scale value.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

Currently, there are two ways to fit an image to a cell. One is by setting the bIsFit value of the DISPCELLPROPERTIES structure to true (also remembering to set the corresponding uMask value), and then send this structure to the LImageViewerCell::SetCellProperties function. The other method is by using the LImageViewerCell::GetCellScale and LImageViewerCell::SetCellScale functions. If using these make sure that bIsFit is set to FALSE.

To set the scale of a cell or sub-cell call LImageViewerCell::SetCellScale function, and to set the properties of the scale action use the LImageViewerCell::SetActionProperties function. To retrieve the properties of the scale action use the LImageViewerCell::GetActionProperties function. To set the scale mode of a cell or sub-cell call the LImageViewerCell::SetCellScaleMode function and to get it call the LImageViewerCell::GetCellScaleMode 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::GetCellScaleMode
• LImageViewerCell::SetCellScaleMode
• LImageViewerCell::SetCellScale
• LImageViewer::Create
• LImageViewer::RemoveCell
• LImageViewer::InsertCell
• LImageViewer::GetCellCount
• LImageViewer::GetCellWindowHandle
• LImageViewerCell::SetCellTag
• LImageViewerCell::SetCellProperties
• LImageViewerCell::AddAction
• LImageViewerCell::SetAction
• LImageViewerCell::GetActionProperties
• LImageViewerCell::RemoveAction
• LImageViewerCell::GetActionCount
• Class Members

Topics

• Applying Actions
• Image Viewer Functions: Applying Actions

Example

For an example, refer to LImageViewerCell::BeginUpdate.