Converted Method

Returns the value of this AnnLength structure converted to one using the specified AnnUnit unit of measure.

Syntax

C#
Visual Basic
Objective-C
Java
C++

public float Converted( 
   AnnUnitConverter converter,
   AnnUnit unit
)

'Declaration
 
Public Function Converted( _
   ByVal converter As AnnUnitConverter, _
   ByVal unit As AnnUnit _
) As Single

'Usage
 
Dim instance As AnnLength
Dim converter As AnnUnitConverter
Dim unit As AnnUnit
Dim value As Single
 
value = instance.Converted(converter, unit)

public:
float Converted( 
   AnnUnitConverter^ converter,
   AnnUnit unit
)

Parameters

converter: AnnUnitConverter object to be used in converting the value.
unit: Destination AnnUnit unit of measure.

Return Value

A value of this AnnLength structure, converted to one using the specified AnnUnit unit of measure.

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).

Example

This example creates a new AnnLength in inches then displays the value in pixels.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Annotations
Imports Leadtools.Codecs
Imports Leadtools.WinForms

Public Sub AnnLength_Converted()
   ' set up a new unit converter with 96 DPI
   Dim converter As AnnUnitConverter = New AnnUnitConverter(96, 96)
   ' create a new annotation length of 1.5 inches
   Dim ln As AnnLength = New AnnLength(1.5F, AnnUnit.Inch)

   ' show the length
   MessageBox.Show(ln.ToString())

   ' show the value converted to pixels
   Dim s As String = String.Format("Is {0} Pixels", ln.Converted(converter, AnnUnit.Pixel))
   MessageBox.Show(s)
End Sub

using Leadtools;
using Leadtools.Annotations;
using Leadtools.Codecs;
using Leadtools.WinForms;

public void AnnLength_Converted()
{
   // set up a new unit converter with 96 DPI
   AnnUnitConverter converter = new AnnUnitConverter(96, 96);
   // create a new annotation length of 1.5 inches
   AnnLength ln = new AnnLength(1.5f, AnnUnit.Inch);

   // show the length
   MessageBox.Show(ln.ToString());

   // show the value converted to pixels
   string s = string.Format("Is {0} Pixels", ln.Converted(converter, AnnUnit.Pixel));
   MessageBox.Show(s);
}

Requirements

Target Platforms

Reference

AnnLength Structure
AnnLength Members