converter: AnnUnitConverter object used in converting the width.

unit: AnnUnit value that indicates the units to which to convert the width.

Returns the value of the width or horizontal component of this AnnSize structure, in the units specified in the unit parameter.

Syntax

Visual Basic (Declaration)
Public Function ConvertedWidth( _ ByVal converter As AnnUnitConverter, _ ByVal unit As AnnUnit _ ) As Single

Visual Basic (Usage)	Copy Code
`Dim instance As AnnSize Dim converter As AnnUnitConverter Dim unit As AnnUnit Dim value As Single value = instance.ConvertedWidth(converter, unit)`

C#
public float ConvertedWidth( AnnUnitConverter converter, AnnUnit unit )

C++/CLI
public: float ConvertedWidth( AnnUnitConverter^ converter, AnnUnit unit )

Parameters

converter: AnnUnitConverter object used in converting the width.
unit: AnnUnit value that indicates the units to which to convert the width.

Return Value

The width or horizontal component of this AnnSize structure, in the specified units.

Example

This example creates a new AnnSize structure in inches and then displays the width and height in pixels.

Visual Basic Copy Code

Visual Basic	Copy Code
Public Sub AnnSize_ConvertedWidth() ' set up a new unit converter with 96 DPI Dim converter As AnnUnitConverter = New AnnUnitConverter(96, 96) ' create a new annotation size with dimension of 1.5, 2 in inches Dim sz As AnnSize = New AnnSize(1.5F, 2.0F, AnnUnit.Inch) Dim s As String ' show the size s = String.Format("Size is {0}", sz) MessageBox.Show(s) ' show the width and height components converted to pixels s = String.Format("width and height is {0}, {1} Pixels", sz.ConvertedWidth(converter, AnnUnit.Pixel), sz.ConvertedHeight(converter, AnnUnit.Pixel)) MessageBox.Show(s) End Sub

Public Sub AnnSize_ConvertedWidth()

   ' set up a new unit converter with 96 DPI

   Dim converter As AnnUnitConverter = New AnnUnitConverter(96, 96)

   ' create a new annotation size with dimension of 1.5, 2 in inches

   Dim sz As AnnSize = New AnnSize(1.5F, 2.0F, AnnUnit.Inch)



   Dim s As String

   ' show the size

   s = String.Format("Size is {0}", sz)

   MessageBox.Show(s)



   ' show the width and height components converted to pixels

   s = String.Format("width and height is {0}, {1} Pixels", sz.ConvertedWidth(converter, AnnUnit.Pixel), sz.ConvertedHeight(converter, AnnUnit.Pixel))

   MessageBox.Show(s)

End Sub

C# Copy Code

C#	Copy Code
public void AnnSize_ConvertedWidth() { // set up a new unit converter with 96 DPI AnnUnitConverter converter = new AnnUnitConverter(96, 96); // create a new annotation size with dimension of 1.5, 2 in inches AnnSize sz = new AnnSize(1.5f, 2f, AnnUnit.Inch); string s; // show the size s = string.Format("Size is {0}", sz); MessageBox.Show(s); // show the width and height components converted to pixels s = string.Format("width and height is {0}, {1} Pixels", sz.ConvertedWidth(converter, AnnUnit.Pixel), sz.ConvertedHeight(converter, AnnUnit.Pixel)); MessageBox.Show(s); }

public void AnnSize_ConvertedWidth() 
{ 
   // set up a new unit converter with 96 DPI 
   AnnUnitConverter converter = new AnnUnitConverter(96, 96); 
   // create a new annotation size with dimension of 1.5, 2 in inches 
   AnnSize sz = new AnnSize(1.5f, 2f, AnnUnit.Inch); 
 
   string s; 
   // show the size 
   s = string.Format("Size is {0}", sz); 
   MessageBox.Show(s); 
 
   // show the width and height components converted to pixels 
   s = string.Format("width and height is {0}, {1} Pixels", sz.ConvertedWidth(converter, AnnUnit.Pixel), sz.ConvertedHeight(converter, AnnUnit.Pixel)); 
   MessageBox.Show(s); 
}

Remarks

The AnnUnitConverter object specified in converter is used to do the actual conversion. If converter is null (Nothing in Visual Basic), the default AnnUnitConverter is used, and the conversion will be done using 96 DPI.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Leadtools.Annotations	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 16.5.9.25
ConvertedWidth Method
See Also Example