←Select platform

SetUnitAbbreviation Method

Summary

Modifies the default string abbreviation to be used with a specific unit.

Syntax

C++

public static string SetUnitAbbreviation(  
   Leadtools.Annotations.AnnUnit unit, 
   string newValue 
)

  
Public Shared Function SetUnitAbbreviation( _ 
   ByVal unit As Leadtools.Annotations.AnnUnit, _ 
   ByVal newValue As String _ 
) As String

public: 
static String^ SetUnitAbbreviation(  
   Leadtools.Annotations.AnnUnit unit, 
   String^ newValue 
)

Parameters

unit
An AnnUnit value to change its abbreviation.

newValue
A string value that specifies the abbreviation to be used with unit.

Return Value

A System.String that specifes the previous default value.

Remarks

You can use this method to globally change the abbreviation used with any unit during the life of your program.

Example

This example will change the abbreviation of SmartEnglish from the default of "in" to "inch":

using Leadtools; 
using Leadtools.Annotations; 
 
private void AnnUnitConverter_SetUnitAbbreviation() 
{ 
   AnnRulerObject ruler1 = new AnnRulerObject(); 
   ruler1.MeasurementUnit = AnnUnit.SmartEnglish; 
   // Should be the default of "in" 
   Console.WriteLine("UnitAbbreviation: {0}", ruler1.UnitAbbreviation); 
 
   // Change the default abbreviation of SmartEnglish to "inches" 
   AnnUnitConverter.SetUnitAbbreviation(AnnUnit.SmartEnglish, "inches"); 
 
   // Create another ruler with SmartEnglish measurement units 
   AnnRulerObject ruler2 = new AnnRulerObject(); 
   ruler2.MeasurementUnit = AnnUnit.SmartEnglish; 
   // Should be the new value of "inches" 
   Console.WriteLine("UnitAbbreviation: {0}", ruler2.UnitAbbreviation); 
}

Imports Leadtools 
Imports Leadtools.Annotations 
 
Private Sub AnnUnitConverter_SetUnitAbbreviation() 
   Dim ruler1 As New AnnRulerObject() 
   ruler1.MeasurementUnit = AnnUnit.SmartEnglish 
   ' Should be the default of "in" 
   Console.WriteLine("UnitAbbreviation: {0}", ruler1.UnitAbbreviation) 
 
   ' Change the default abbreviation of SmartEnglish to "inches" 
   AnnUnitConverter.SetUnitAbbreviation(AnnUnit.SmartEnglish, "inches") 
 
   ' Create another ruler with SmartEnglish measurement units 
   Dim ruler2 As New AnnRulerObject() 
   ruler2.MeasurementUnit = AnnUnit.SmartEnglish 
   ' Should be the new value of "inches" 
   Console.WriteLine("UnitAbbreviation: {0}", ruler2.UnitAbbreviation) 
End Sub