←Select platform

ConvertedWidth Method

Summary

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

unit parameter.

Syntax

C#
VB
C++
public float ConvertedWidth( 
   AnnUnitConverter converter, 
   AnnUnit unit 
) 
  
Public Function ConvertedWidth( _ 
   ByVal converter As Leadtools.Annotations.AnnUnitConverter, _ 
   ByVal unit As Leadtools.Annotations.AnnUnit _ 
) As Single 

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.

Remarks

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

Example

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

C#
VB
using Leadtools; 
using Leadtools.Annotations; 
 
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); 
} 
Imports Leadtools 
Imports Leadtools.Annotations 
 
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 

Requirements

Target Platforms

See Also

Reference

AnnSize Structure

AnnSize Members

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations Assembly