UnitSystemName

Returns the name of the current unit system.

Syntax

rhinoscriptsyntax.UnitSystemName( capitalize=False, singular=True, abbreviate=False, model_units=True)

rhinoscript.document.UnitSystemName( capitalize=False, singular=True, abbreviate=False, model_units=True)

Parameters

capitalize

Optional.  Boolean.  Capitalize the first character of the units system name (e.g. return "Millimeter" instead of "millimeter"). The default is not to capitalize the first character (false).

singular

Optional.  Boolean. Return the singular form of the units system name (e.g. "millimeter" instead of "millimeters"). The default is to return the singular form of the name (true).

abbreviate

Optional.  Boolean.  Abbreviate the name of the units system (e.g. return "mm" instead of "millimeter"). The default is not to abbreviate the name (false).

model_units

Optional.  Boolean.  Return the document's model units (True) or the document's page units (False). The default is True.

Returns

String

The name of the current units system if successful.

Example

import rhinoscriptsyntax as rs

system = rs.UnitSystemName(False, False, False)

print "The units system is set to", system

Also See

UnitSystem