LEADTOOLS Annotations (Leadtools.Annotations assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
ConvertedX Method
See Also 
Leadtools.Annotations Namespace > AnnPoint Structure : ConvertedX Method



converter
AnnUnitConverter object to be used in converting the x-coordinate.
unit
Destination AnnUnit unit of measure.

The ConvertedX Method is available in LEADTOOLS Document and Medical Imaging toolkits.

converter
AnnUnitConverter object to be used in converting the x-coordinate.
unit
Destination AnnUnit unit of measure.
Returns the value of the x-coordinate of this AnnPoint structure converted to its equivalent in the specified AnnUnit unit of measure.

Syntax

Visual Basic (Declaration) 
Public Function ConvertedX( _
   ByVal converter As AnnUnitConverter, _
   ByVal unit As AnnUnit _
) As Single
Visual Basic (Usage)Copy Code
Dim instance As AnnPoint
Dim converter As AnnUnitConverter
Dim unit As AnnUnit
Dim value As Single
 
value = instance.ConvertedX(converter, unit)
C# 
public float ConvertedX( 
   AnnUnitConverter converter,
   AnnUnit unit
)
C++/CLI 
public:
float ConvertedX( 
   AnnUnitConverter^ converter,
   AnnUnit unit
) 

Parameters

converter
AnnUnitConverter object to be used in converting the x-coordinate.
unit
Destination AnnUnit unit of measure.

Return Value

The value of the x-coordinate of this AnnPoint converted to its equivalent using the specified AnnUnit unit of measure.

Example

This example creates a new AnnPoint in inches and then displays the X and Y coordinate values in pixels.

Visual BasicCopy Code
Public Sub AnnPoint_ConvertedX()
   ' set up a new unit converter with 96 DPI
   Dim converter As AnnUnitConverter = New AnnUnitConverter(96, 96)
   ' create a new annotation point at inch coordinate 1.5, 2
   Dim pt As AnnPoint = New AnnPoint(1.5F, 2.0F, AnnUnit.Inch)

   ' show the point
   Dim s As String
   s = String.Format("Show the point: {0}", pt)
   MessageBox.Show(s)

   ' show the X,Y coordinates converted to pixels
   s = String.Format("show the X,Y coordinates converted to pixels: Is {0}, {1} Pixels", pt.ConvertedX(converter, AnnUnit.Pixel), pt.ConvertedY(converter, AnnUnit.Pixel))
   MessageBox.Show(s)
End Sub
C#Copy Code
public void AnnPoint_ConvertedX()
{
   // set up a new unit converter with 96 DPI
   AnnUnitConverter converter = new AnnUnitConverter(96, 96);
   // create a new annotation point at inch coordinate 1.5, 2
   AnnPoint pt = new AnnPoint(1.5f, 2f, AnnUnit.Inch);

   // show the point
   string s;
   s = string.Format("Show the point: {0}", pt);
   MessageBox.Show(s);

   // show the X,Y coordinates converted to pixels
   s = string.Format("show the X,Y coordinates converted to pixels: Is {0}, {1} Pixels", pt.ConvertedX(converter, AnnUnit.Pixel), pt.ConvertedY(converter, AnnUnit.Pixel));
   MessageBox.Show(s);
}

Remarks

converter is used to do the actual conversion. If converter is null (Nothing in Visual Basic), the default AnnUnitConverter is used (in other words, conversion will be done based on the default 96 DPI).

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Annotations requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features