CIMNumberFormat.md

June 24, 2022 ยท View on GitHub

CIMAngleFormat

Represents an angle format.

CIMNumberFormat

PropertyTypeDescription

CIMNumericFormat

PropertyTypeDescription
alignmentOptionenumeration esriNumericAlignmentEnumThe alignment option.
alignmentWidthlongThe alignment width.
roundingOptionenumeration esriRoundingOptionEnumThe rounding option.
roundingValuelongThe rounding value, whose meaning depends on the rounding option.
showPlusSignbooleanA value indicating whether formatted numbers contain a plus sign for positive numbers.
useSeparatorbooleanA value indicating whether formatted numbers contain digit grouping symbols.
zeroPadbooleanA value indicating whether formatted numbers contain padded zeros to the right of the decimal.

CIMAngleFormat

PropertyTypeDescription
angleInDegreesbooleanA value indicating whether to display the angle in degrees.
displayDegreesbooleanA value indicating whether to display degrees.

CIMCurrencyFormat

Represents a currency format.

CIMNumberFormat

PropertyTypeDescription

CIMCurrencyFormat

PropertyTypeDescription

CIMCustomNumberFormat

Represents a custom number format.

CIMNumberFormat

PropertyTypeDescription

CIMCustomNumberFormat

PropertyTypeDescription
formatStringstringThe format string (e.g. ###-##-####).

CIMDateFormat

Represents a standard date and time format. https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings. Examples: "MM/dd/yyyy" 06/12/2020 "dddd, dd MMMM yyyy" Friday, 12 June 2020 "dddd, dd MMMM yyyy HH:mm:ss" Friday, 12 June 2020 08:30:01 "MM/dd/yyyy HH:mm" 06/12/2020 08:30 "MM/dd/yyyy hh:mm tt" 06/12/2020 08:30 AM "MMMM dd" June 12 "hh:mm tt" 08:30 AM "HH:mm:ss" 08:30:06.

CIMNumberFormat

PropertyTypeDescription

CIMDateFormat

PropertyTypeDescription
formatstringThe date format string.

CIMDirectionFormat

Represents a direction format.

CIMNumberFormat

PropertyTypeDescription

CIMDirectionFormat

PropertyTypeDescription
decimalPlaceslongThe number of decimal places to show.
formatenumeration DirectionFormatOptionThe format.
directionTypeenumeration DirectionTypeThe direction type.
unitsenumeration DirectionUnitsThe direction units.
useNegativeAnglesbooleanA value indicating whether of not to use negative angles.

Enumeration: DirectionFormatOption

Direction format options.

PropertyValueDescription
DegreesMinutesSeconds0Degrees minutes seconds.
QuadrantBearing1Quadrant bearing.

Enumeration: DirectionType

Direction type.

PropertyValueDescription
NorthAzimuth0North azimuth.
SouthAzimuth1South azimuth.
Polar2Polar.
QuadrantBearing3Quadrant bearing.

Enumeration: DirectionUnits

Direction units.

PropertyValueDescription
Radians0Radians
DecimalDegrees1Decimal degrees.
DegreesMinutesSeconds2Degrees minutes seconds.
Gradians3Gradians.
Gons4Gons.

CIMFractionFormat

Represents a fraction format.

CIMNumberFormat

PropertyTypeDescription

CIMFractionFormat

PropertyTypeDescription
optionenumeration FractionOptionThe fraction option determines how the numerator and denominator of the fraction are treated.
factorlongThe maximum number of digits for the numerator or denominator, or the denominator of the formatted fraction.

Enumeration: FractionOption

Fraction options.

PropertyValueDescription
Digits0Digits.
Denominator1Denominator.

CIMLatLonFormat

Represents a latitude and longitude format.

CIMNumberFormat

PropertyTypeDescription

CIMNumericFormat

PropertyTypeDescription
alignmentOptionenumeration esriNumericAlignmentEnumThe alignment option.
alignmentWidthlongThe alignment width.
roundingOptionenumeration esriRoundingOptionEnumThe rounding option.
roundingValuelongThe rounding value, whose meaning depends on the rounding option.
showPlusSignbooleanA value indicating whether formatted numbers contain a plus sign for positive numbers.
useSeparatorbooleanA value indicating whether formatted numbers contain digit grouping symbols.
zeroPadbooleanA value indicating whether formatted numbers contain padded zeros to the right of the decimal.

CIMLatLonFormat

PropertyTypeDescription
showDirectionsbooleanA value indicating whether a directional letter (N-S-E-W) is appended to the formatted number.
isLatitudebooleanA value indicating whether a formatted number is a latitude or not.
showZeroMinutesbooleanA value indicating whether zero minutes are included in formatted output.
showZeroSecondsbooleanA value indicating whether zero seconds are included in formatted output.

Enumeration: NumericAlignment

Numeric alignment types.

PropertyValueDescription
AlignRight0Align right.
AlignLeft1Align left.

CIMNumericFormat

Represents a numeric format.

CIMNumberFormat

PropertyTypeDescription

CIMNumericFormat

PropertyTypeDescription
alignmentOptionenumeration esriNumericAlignmentEnumThe alignment option.
alignmentWidthlongThe alignment width.
roundingOptionenumeration esriRoundingOptionEnumThe rounding option.
roundingValuelongThe rounding value, whose meaning depends on the rounding option.
showPlusSignbooleanA value indicating whether formatted numbers contain a plus sign for positive numbers.
useSeparatorbooleanA value indicating whether formatted numbers contain digit grouping symbols.
zeroPadbooleanA value indicating whether formatted numbers contain padded zeros to the right of the decimal.

CIMNumericFormatSuffix

PropertyTypeDescription
suffixstringThe numeric suffix.

CIMPercentageFormat

Represents a percentage format.

CIMNumberFormat

PropertyTypeDescription

CIMNumericFormat

PropertyTypeDescription
alignmentOptionenumeration esriNumericAlignmentEnumThe alignment option.
alignmentWidthlongThe alignment width.
roundingOptionenumeration esriRoundingOptionEnumThe rounding option.
roundingValuelongThe rounding value, whose meaning depends on the rounding option.
showPlusSignbooleanA value indicating whether formatted numbers contain a plus sign for positive numbers.
useSeparatorbooleanA value indicating whether formatted numbers contain digit grouping symbols.
zeroPadbooleanA value indicating whether formatted numbers contain padded zeros to the right of the decimal.

CIMPercentageFormat

PropertyTypeDescription
adjustPercentagebooleanA value indicating whether or not to adjust the percentage.

CIMRateFormat

Represents a rate format.

CIMNumberFormat

PropertyTypeDescription

CIMNumericFormat

PropertyTypeDescription
alignmentOptionenumeration esriNumericAlignmentEnumThe alignment option.
alignmentWidthlongThe alignment width.
roundingOptionenumeration esriRoundingOptionEnumThe rounding option.
roundingValuelongThe rounding value, whose meaning depends on the rounding option.
showPlusSignbooleanA value indicating whether formatted numbers contain a plus sign for positive numbers.
useSeparatorbooleanA value indicating whether formatted numbers contain digit grouping symbols.
zeroPadbooleanA value indicating whether formatted numbers contain padded zeros to the right of the decimal.

CIMRateFormat

PropertyTypeDescription
factordoubleThe rate factor.
labelstringThe label appended to the formatted rate number.

Enumeration: RoundingOption

Rounding options.

PropertyValueDescription
NumberOfDecimals0Rounding by number of decimals.
NumberOfSignificantDigits1Rounding by number of significant digits.

CIMScientificNumberFormat

Represents scientific number format.

CIMNumberFormat

PropertyTypeDescription

CIMScientificNumberFormat

PropertyTypeDescription
decimalPlaceslongThe number of decimal places to show.