LAnnAutomation::SetBitmapDpiX

Show in webframe

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetBitmapDpiX(dDpiX, uFlags=0)

L_DOUBLE dDpiX;	/* horizontal DPI value to set */
L_UINT uFlags;	/* reserved for future use */

Sets the horizontal Bitmap DPI (dots per inch) value that is used to translate the horizontal distance for Ruler objects.

Parameter	Description
dDpiX	The horizontal 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

You should set this value to the bitmaps XResolution. 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.

Platforms

Win32, x64.

See Also

Functions:	LAnnAutomation::SetBitmapDpiY, LAnnAutomation::GetBitmapDpiX, LAnnAutomation::GetBitmapDpiY, LAnnAutomation::SetUnit, LAnnAutomation::GetUnit, LAnnAutomation::GetDistance, LAnnAutomation::SetGaugeLength, LAnnAutomation::GetGaugeLength, Class Members, LAnnAutomation::GetTicMarkLength, LAnnAutomation::SetTicMarkLength, LAnnPolyRuler::GetDistance2, ANNSMARTDISTANCE, LAnnotation::CalibrateRuler
Topics:	Annotation Functions: Working with the Toolbar
	Implementing Annotations
	Automated User Interface for Annotations
	Using Rulers in Annotation Objects
	Key Annotation Features
	Calibrating Annotation Ruler Objects

Example

L_INT LAnnAutomation_SetBitmapDpiXExample(LAnnAutomation  * pAutomation, LBitmapBase * pBitmap) 
{
   L_INT nRet;
   L_DOUBLE xRes;
   L_DOUBLE yRes;
   /* get the bitmap x and y res from the object */
   xRes = pAutomation->GetBitmapDpiX();
   yRes = pAutomation->GetBitmapDpiY();
   /* set all selected items to have the same dpi for ruler  tool as the bitmap */
   if(xRes != (L_DOUBLE) pBitmap->GetXResolution())
   {
      nRet = pAutomation->SetBitmapDpiX((L_DOUBLE) pBitmap->GetXResolution(), 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   if(yRes != (L_DOUBLE) pBitmap->GetYResolution())
   {
      nRet = pAutomation->SetBitmapDpiY((L_DOUBLE) pBitmap->GetYResolution(), 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}