GetPaperUnitNames()

Summary

Gets a list of the available paper measurement units.

 

Changes

In Version 2018 added the format types "Display Abbreviation", "Display Singular", and "Display Plural".

 

Syntax

paper_units = GetPaperUnitNames(string format_type)

 

Argument	Contents
format_type	Format of the measurement unit: "Abbrev", "Singular", "Plural, "Display Abbrev", "Display Singular", or "Display Plural" . If null, Plural is the default.

 

Returns

An array of strings listing available paper measurement units.

 

Notes

• Paper units are used to control layouts and to set the basis for map scales (e.g., the "inch" part of miles/inch).

• With the "Display" format types, GetPaperUnitNames() returns the corresponding "Display" version that was set up with SetDisplayUnits().

Example

p1 = GetPaperUnitNames("Plural")	// p1 is {"Inches", "Centimeters", ...}
p2 = GetPaperUnitNames("Singular")	// p2 is {"Inch", "Centimeter", ...}
p3 = GetPaperUnitNames("Abbreviation")	// p3 is {"in", "cm", ...}

 

Error Codes

Error Type	Meaning
Error	format_type is incorrectly specified

 

See Also

Function	Summary
GetPaperUnits()	Gets the current paper measurement unit
SetPaperUnits()	Sets the current paper measurement unit
GetMapUnitNames()	Gets a list of the available map measurement units