LAnnotation::GetOffsetX

#include "ltwrappr.h"

virtual L_DOUBLE LAnnotation::GetOffsetX()

Gets the X offset of the annotation object.

Returns

The specified object's X offset.

Comments

Typically, this value is used to match the root container's offset to the offset of the associated bitmap's display rectangle.

The offset values are applied after the scalar properties, which are set by the LAnnotation::SetScalarX and LAnnotation::SetScalarY functions. For more information, refer to Low-Level Coordinate System for Annotations.

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:	Class Members
Topics:	Annotation Functions: Getting and Setting Geometric Properties
	Low-Level Coordinate System for Annotations
	Fixed Annotations
	Minimizing Flicker With Double Buffering

Example

L_INT LAnnotation_GetOffsetXExample(LAnnotation& LeadAnn)
{
   L_INT nRet;
   L_DOUBLE dOffsetX, dOffsetY; // Variables for updating offsets
   ANNRECT AnnRect;
   
   dOffsetX = LeadAnn.GetOffsetX();
   dOffsetY = LeadAnn.GetOffsetY();
   
   // Get the container rectangle to use for positioning the line
   nRet = LeadAnn.GetRect( &AnnRect);
   if(nRet != SUCCESS)
      return nRet;
   
   nRet = LeadAnn.SetOffsetX( dOffsetX + ((AnnRect.right - AnnRect.left) / 20));
   if(nRet != SUCCESS)
      return nRet;
   nRet = LeadAnn.SetOffsetY( dOffsetY + ((AnnRect.bottom - AnnRect.top) / 20));
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}