Leadtools.Annotations Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
Converted Method
See Also  Example
Leadtools.Annotations Namespace > AnnLength Structure : Converted Method



converter
AnnUnitConverter object to be used in converting the value.
unit
Destination AnnUnit unit of measure.
converter
AnnUnitConverter object to be used in converting the value.
unit
Destination AnnUnit unit of measure.
Returns the value of this AnnLength structure converted to one using the specified AnnUnit unit of measure.

Syntax

Visual Basic (Declaration) 
Public Function Converted( _
   ByVal converter As AnnUnitConverter, _
   ByVal unit As AnnUnit _
) As Single
Visual Basic (Usage)Copy Code
Dim instance As AnnLength
Dim converter As AnnUnitConverter
Dim unit As AnnUnit
Dim value As Single
 
value = instance.Converted(converter, unit)
C# 
public float Converted( 
   AnnUnitConverter converter,
   AnnUnit unit
)
C++/CLI 
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.

Example

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

Visual BasicCopy Code
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
C#Copy Code
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); 
}

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 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

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