This document is archived and information here might be outdated.  Recommended version.


IAngularUnitEdit.Define Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Geometry)  

IAngularUnitEdit.Define Method

Defines the properties of an angular unit.

[Visual Basic .NET]
Public Sub Define ( _
    [ByRef Name As Object], _
    [ByRef Alias As Object], _
    [ByRef Abbreviation As Object], _
    [ByRef Remarks As Object], _
    [ByRef RadiansPerUnit As Object] _
)
[C#]
public void Define (
    ref object Name,
    ref object Alias,
    ref object Abbreviation,
    ref object Remarks,
    ref object RadiansPerUnit
);
[C#]

Optional Values

Name   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
Alias   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
Abbreviation   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
Remarks   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
RadiansPerUnit   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
[C++]
HRESULT Define(
  VARIANT* Name,
  VARIANT* Alias,
  VARIANT* Abbreviation,
  VARIANT* Remarks,
  VARIANT* RadiansPerUnit
);
[C++]

Parameters Name [optional] Name is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. Alias [optional] Alias is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. Abbreviation [optional] Abbreviation is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. Remarks [optional] Remarks is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. RadiansPerUnit [optional] RadiansPerUnit is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

The Define function allows you to define the properties of a angular unit of measure. The radiansPerUnit parameter defines the relationship of a unit object to radians.

[C#]
private void defineAngularUnit()
{
    IAngularUnit angularUnit=new AngularUnitClass();
    //Query interface for AngularUnitEdit
    IAngularUnitEdit angularUnitEdit=angularUnit as IAngularUnitEdit;
    //Define the properties for the angular unit
    object name="Degree";
    object alias="Degree";
    object abbreviation="Deg";
    object remarks="Angular unit is degree";
    object radiantsPerUnit=1;
    angularUnitEdit.Define(ref name, ref alias, ref abbreviation, ref remarks, ref radiantsPerUnit);
}
[Visual Basic .NET]

    Sub DefineAngularUnit()
        Dim pAngUnit As IAngularUnit
        Dim pAngUnitEdit As IAngularUnitEdit
        pAngUnit=New AngularUnit
        'Query interface for AngularUnitEdit
        pAngUnitEdit=pAngUnit

        'Define the properties for the angular unit
        pAngUnitEdit.Define(Name:="Degree", Alias:="Degree", Abbreviation:="Deg", Remarks:="Angular unit is degree", RadiansPerUnit:=1)
    End Sub

See Also

IAngularUnitEdit Interface