LEADTOOLS Medical (Leadtools.Medical3D assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
CalibrateRuler(Double,MedicalViewerMeasurementUnit) Method
See Also 
Leadtools.Medical3D Namespace > Medical3DControl Class > CalibrateRuler Method : CalibrateRuler(Double,MedicalViewerMeasurementUnit) Method



distance
The new length of the annotation ruler.
measurementUnit
The unit of measure

The CalibrateRuler(Double,MedicalViewerMeasurementUnit) Method is available as an add-on to the LEADTOOLS Medical Imaging toolkits.

distance
The new length of the annotation ruler.
measurementUnit
The unit of measure
Changes the length of the selected annotation ruler according to the new value.

Syntax

Visual Basic (Declaration) 
Overloads Public Sub CalibrateRuler( _
   ByVal distance As Double, _
   ByVal measurementUnit As MedicalViewerMeasurementUnit _
) 
Visual Basic (Usage)Copy Code
Dim instance As Medical3DControl
Dim distance As Double
Dim measurementUnit As MedicalViewerMeasurementUnit
 
instance.CalibrateRuler(distance, measurementUnit)
C# 
public void CalibrateRuler( 
   double distance,
   MedicalViewerMeasurementUnit measurementUnit
)
C++/CLI 
public:
void CalibrateRuler( 
   double distance,
   MedicalViewerMeasurementUnit measurementUnit
) 

Parameters

distance
The new length of the annotation ruler.
measurementUnit
The unit of measure

Example

Calibrate a ruler if there is one to 10.0 cm.

Visual BasicCopy Code
' You will need to add a ruler before being able to use this example.
Public Sub MedicalViewerCalibrateRulerExample()
   Dim myForm As MedicalViewerForm = GetMedicalControl()
   Dim medicalViewer As MedicalViewer = myForm.Viewer

   Dim annotationAttributes As MedicalViewerAnnotationAttributes = (CType(medicalViewer.Cells(0), MedicalViewerMultiCell)).GetSelectedAnnotationAttributes(-2)
   Select Case annotationAttributes.Type
      Case MedicalViewerActionType.AnnotationRuler
         CType(medicalViewer.Cells(0), MedicalViewerMultiCell).CalibrateRuler(10.0, MedicalViewerMeasurementUnit.Centimeters)
      Case Else
         MessageBox.Show("You should add a ruler annotation to calibrate")
   End Select
   myForm.ShowDialog()
End Sub
C#Copy Code
// You will need to add a ruler before being able to use this example.
public void MedicalViewerCalibrateRulerExample()
{
   MedicalViewerForm myForm = GetMedicalControl();
   MedicalViewer medicalViewer = myForm.Viewer;

   MedicalViewerAnnotationAttributes annotationAttributes = ((MedicalViewerMultiCell)(medicalViewer.Cells[0])).GetSelectedAnnotationAttributes(-2);
   switch (annotationAttributes.Type)
   {
      case MedicalViewerActionType.AnnotationRuler:
         ((MedicalViewerMultiCell)(medicalViewer.Cells[0])).CalibrateRuler(10.0, MedicalViewerMeasurementUnit.Centimeters);
         break;
      default:
         MessageBox.Show("You should add a ruler annotation to calibrate");
         break;
   }
   myForm.ShowDialog();
}

Remarks

This method will calibrate all the rulers that are selected in the sub-cells included within the cell.

For more information, refer to Working With Annotations.

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.Medical3D requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features