LEADTOOLS Annotations (Leadtools.Annotations assembly)
LEAD Technologies, Inc

SetUnitAbbreviation Method

Example 





An AnnUnit value to change its abbreviation.
A string value that specifies the abbreviation to be used with unit.
Modifies the default string abbreviation to be used with a specific unit.
Syntax
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
)
 function Leadtools.Annotations.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.
Remarks

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

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

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

AnnUnitConverter Class
AnnUnitConverter Members

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.