UnitInfo Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}  
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:UnitInfo Class.Cmt}}  
In Synthesis desktop applications, these units are shown in the Manage Units window.


== Constructors ==
 
*[[UnitInfo Constructors|UnitInfo( Integer, String, String, Double )]] {{APIComment|{{Template:UnitInfo Constructors.Cmt}}}}
<onlyinclude>Represents the unit of measurement used by an associated [[Repository_Class|Repository]] object.</onlyinclude>


== Properties  ==
== Properties  ==
*ID (as ''integer'') {{APIComment|The numerical ID of the unit.}}
{| {{APITable}}
*Name (as ''string'') {{APIComment| The name of the unit.}}
|-
*Abbreviation (as ''string'') {{APIComment| The abbreviation of the unit.}}
| style="width: 130px;"|Abbreviation||Gets or sets the abbreviation of the unit. '''String'''.
*Multiplier (''as double'') {{APIComment|The multiplier of the unit (i.e., the value to multiply by the Standard Base Unit (SBU), which determines how units are converted).}}
|-
|ID||Gets or sets the numeric ID of the unit. '''Integer'''.
|-
|Multiplier||Gets or sets the conversion factor, which is defined in relation to a repository's System Base Unit (SBU). '''Double'''.
|-
|Name||Gets or sets the name of the unit. '''String'''.
|}
 
 
 
 
 
==See Also==
*[[Repository.Unit.GetAllUnits|Repository.Unit.GetAllUnits Method]]

Latest revision as of 15:04, 8 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents the unit of measurement used by an associated Repository object.

Properties

Name Description
Abbreviation Gets or sets the abbreviation of the unit. String.
ID Gets or sets the numeric ID of the unit. Integer.
Multiplier Gets or sets the conversion factor, which is defined in relation to a repository's System Base Unit (SBU). Double.
Name Gets or sets the name of the unit. String.



See Also