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



value
Value to be converted. This is in srcUnit units.
srcUnit
Source AnnUnit.
destUnit
Destination AnnUnit.

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

value
Value to be converted. This is in srcUnit units.
srcUnit
Source AnnUnit.
destUnit
Destination AnnUnit.
Converts a value from one unit to another using the horizontal DPI value.

Syntax

Visual Basic (Declaration) 
Public Function ConvertHorizontal( _
   ByVal value As Single, _
   ByVal srcUnit As AnnUnit, _
   ByVal destUnit As AnnUnit _
) As Single
Visual Basic (Usage)Copy Code
Dim instance As AnnUnitConverter
Dim value As Single
Dim srcUnit As AnnUnit
Dim destUnit As AnnUnit
Dim value As Single
 
value = instance.ConvertHorizontal(value, srcUnit, destUnit)
C# 
public float ConvertHorizontal( 
   float value,
   AnnUnit srcUnit,
   AnnUnit destUnit
)
C++/CLI 
public:
float ConvertHorizontal( 
   float value,
   AnnUnit srcUnit,
   AnnUnit destUnit
) 

Parameters

value
Value to be converted. This is in srcUnit units.
srcUnit
Source AnnUnit.
destUnit
Destination AnnUnit.

Return Value

The converted value.

Example

This example sets up a unit converter class with different horizontal and vertical DPI values and then converts horizontal and vertical values from pixels to inches.

Visual BasicCopy Code
Public Sub AnnUnitConverter_ConvertHorizontal()
   ' set up a new unit converter with 96 horizontal and 192 vertical DPI
   Dim converter As AnnUnitConverter = New AnnUnitConverter(96, 192)
   Dim pixels As Single = 200

   ' convert using the horizontal DPI
   Dim horzInches As Single = converter.ConvertHorizontal(200, AnnUnit.Pixel, AnnUnit.Inch)

   ' convert using the vertical DPI
   Dim vertInches As Single = converter.ConvertVertical(200, AnnUnit.Pixel, AnnUnit.Inch)

   ' show
   Dim s As String = String.Format("{0} {1} is {2} {3} at {4} X DPI{5}{0} {1} is {6} {3} at {7} Y DPI", pixels, AnnUnitConverter.GetUnitAbbreviation(AnnUnit.Pixel), horzInches, AnnUnitConverter.GetUnitAbbreviation(AnnUnit.Inch), converter.DpiX, Environment.NewLine, vertInches, converter.DpiY)
   MessageBox.Show(s)
End Sub
C#Copy Code
public void AnnUnitConverter_ConvertHorizontal()
{
   // set up a new unit converter with 96 horizontal and 192 vertical DPI
   AnnUnitConverter converter = new AnnUnitConverter(96, 192);
   float pixels = 200;

   // convert using the horizontal DPI
   float horzInches = converter.ConvertHorizontal(200, AnnUnit.Pixel, AnnUnit.Inch);

   // convert using the vertical DPI
   float vertInches = converter.ConvertVertical(200, AnnUnit.Pixel, AnnUnit.Inch);

   // show
   string s = string.Format(
   "{0} {1} is {2} {3} at {4} X DPI{5}{0} {1} is {6} {3} at {7} Y DPI",
   pixels,
   AnnUnitConverter.GetUnitAbbreviation(AnnUnit.Pixel),
   horzInches,
   AnnUnitConverter.GetUnitAbbreviation(AnnUnit.Inch),
   converter.DpiX,
   Environment.NewLine,
   vertInches,
   converter.DpiY);
   MessageBox.Show(s);
}

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