LAnnAutomation::SetBitmapDpiY

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetBitmapDpiY(dDpiY, uFlags=0)

L_DOUBLE dDpiY;

/* vertical DPI value to set */

L_UINT uFlags;

/* reserved for future use */

Sets the vertical Bitmap DPI (dots per inch) value that is used to translate the vertical distance for Ruler objects. This function is available in the Document/Medical Toolkits.

Parameter

Description

dDpiY

The vertical DPI value to set. Valid values are greater than or equal to 1.

 

If you pass 0 or a positive value less than 1, the value will default to 150. If you pass a negative value, the function will return an error.

uFlags

Reserved for future versions, use 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function applies to multiple and selected objects based on the value of the uFlags parameter.

Only Automation and Ruler objects are affected.

You should set this value to the bitmap’s YResolution. Call this function every time you load objects or paste them from the clipboard. Otherwise, the distances shown by the ruler objects will not be accurate.

Required DLLs and Libraries

LTANN

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:

LAnnAutomation::SetBitmapDpiX, LAnnAutomation::GetBitmapDpiX, LAnnAutomation::GetBitmapDpiY, LAnnAutomation::SetUnit, LAnnAutomation::GetUnit, LAnnAutomation::GetDistance, LAnnAutomation::SetGaugeLength, LAnnAutomation::GetGaugeLength, Class Members, LAnnAutomation::GetTicMarkLength, LAnnAutomation::SetTicMarkLength, LAnnotation::CalibrateRuler

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Using Rulers in Annotation Objects

 

New Annotation Features of Version 14.5

 

Calibrating Annotation Ruler Objects

Example

For an example, refer to LAnnAutomation::SetBitmapDpiX.