Description

Returns the Current Unit for a Dimension.

Syntax

[Visual Basic .NET]
Public Function GetCurrentUnitAbbrv( _ ByVal IndexOrDimName As System.Object _ ) As String

[Visual Basic .NET]

Public Function GetCurrentUnitAbbrv( _
   ByVal IndexOrDimName As System.Object _
) As String

[C#]
public string GetCurrentUnitAbbrv( System.Object IndexOrDimName );

[C#]

public string GetCurrentUnitAbbrv(

   System.Object IndexOrDimName

);

[Managed C++]
public: String __gc ^ GetCurrentUnitAbbrv( VARIANT IndexOrDimName );

[Managed C++]

public: String __gc ^ GetCurrentUnitAbbrv(

   VARIANT IndexOrDimName

);

[Java]
public String getCurrentUnitAbbrv( Variant IndexOrDimName );

[Java]

public String getCurrentUnitAbbrv(

   Variant IndexOrDimName

);

[Unmanaged C++]
public: HRESULT GetCurrentUnitAbbrv( VARIANT IndexOrDimName, BSTR * ReturnValue );

[Unmanaged C++]

public: HRESULT GetCurrentUnitAbbrv(

   VARIANT IndexOrDimName, 

   BSTR * ReturnValue

);

Parameters

IndexOrDimName: The index or dimension name

Return Type

Returns the current unit abbreviation for the given index.

Example

[Visual Basic .NET] Copy Code

Dim oSTK As
Object

Dim oStkObjectRoot As AGI.STKObjects.AgStkObjectRoot

Dim distanceUnit As String



Dim oType As Type =
Type.GetTypeFromProgID("STK.Application")

oSTK = Activator.CreateInstance(oType)



oStkObjectRoot = oSTK.GetType().InvokeMember( _

                                        "Personality2",
_

                                        System.Reflection.BindingFlags.GetProperty,
_

                                        Nothing,
_

                                        oSTK,
_

                                        Nothing)



distanceUnit =
oStkObjectRoot.UnitPreferences.GetCurrentUnitAbbrv("DistanceUnit")



MessageBox.Show(distanceUnit)



oStkObjectRoot = Nothing

oSTK = Nothing

Get a current unit preference

[C#] Copy Code

// DistanceUnit 

string dimensionName = "Distance"; 

string unitAbbreviation = root.UnitPreferences.GetCurrentUnitAbbrv(dimensionName);