SetUnitAbbreviation Method

Visual Basic
C#
Objective-C
Java
C++

public static string SetUnitAbbreviation( 
   AnnUnit unit,
   string newValue
)

'Declaration
 
Public Shared Function SetUnitAbbreviation( _
   ByVal unit As AnnUnit, _
   ByVal newValue As String _
) As String

'Usage
 
Dim unit As AnnUnit
Dim newValue As String
Dim value As String
 
value = AnnUnitConverter.SetUnitAbbreviation(unit, newValue)

public:
static String^ SetUnitAbbreviation( 
   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.

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

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

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

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);
}

Target Platforms

Reference

AnnUnitConverter Class
AnnUnitConverter Members