CIMNumberFormat.md
June 24, 2022 ยท View on GitHub
CIMAngleFormat
Represents an angle format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMNumericFormat
| Property | Type | Description |
|---|---|---|
| alignmentOption | enumeration esriNumericAlignmentEnum | The alignment option. |
| alignmentWidth | long | The alignment width. |
| roundingOption | enumeration esriRoundingOptionEnum | The rounding option. |
| roundingValue | long | The rounding value, whose meaning depends on the rounding option. |
| showPlusSign | boolean | A value indicating whether formatted numbers contain a plus sign for positive numbers. |
| useSeparator | boolean | A value indicating whether formatted numbers contain digit grouping symbols. |
| zeroPad | boolean | A value indicating whether formatted numbers contain padded zeros to the right of the decimal. |
CIMAngleFormat
| Property | Type | Description |
|---|---|---|
| angleInDegrees | boolean | A value indicating whether to display the angle in degrees. |
| displayDegrees | boolean | A value indicating whether to display degrees. |
CIMCurrencyFormat
Represents a currency format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMCurrencyFormat
| Property | Type | Description |
|---|
CIMCustomNumberFormat
Represents a custom number format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMCustomNumberFormat
| Property | Type | Description |
|---|---|---|
| formatString | string | The 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
| Property | Type | Description |
|---|
CIMDateFormat
| Property | Type | Description |
|---|---|---|
| format | string | The date format string. |
CIMDirectionFormat
Represents a direction format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMDirectionFormat
| Property | Type | Description |
|---|---|---|
| decimalPlaces | long | The number of decimal places to show. |
| format | enumeration DirectionFormatOption | The format. |
| directionType | enumeration DirectionType | The direction type. |
| units | enumeration DirectionUnits | The direction units. |
| useNegativeAngles | boolean | A value indicating whether of not to use negative angles. |
Enumeration: DirectionFormatOption
Direction format options.
| Property | Value | Description |
|---|---|---|
| DegreesMinutesSeconds | 0 | Degrees minutes seconds. |
| QuadrantBearing | 1 | Quadrant bearing. |
Enumeration: DirectionType
Direction type.
| Property | Value | Description |
|---|---|---|
| NorthAzimuth | 0 | North azimuth. |
| SouthAzimuth | 1 | South azimuth. |
| Polar | 2 | Polar. |
| QuadrantBearing | 3 | Quadrant bearing. |
Enumeration: DirectionUnits
Direction units.
| Property | Value | Description |
|---|---|---|
| Radians | 0 | Radians |
| DecimalDegrees | 1 | Decimal degrees. |
| DegreesMinutesSeconds | 2 | Degrees minutes seconds. |
| Gradians | 3 | Gradians. |
| Gons | 4 | Gons. |
CIMFractionFormat
Represents a fraction format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMFractionFormat
| Property | Type | Description |
|---|---|---|
| option | enumeration FractionOption | The fraction option determines how the numerator and denominator of the fraction are treated. |
| factor | long | The maximum number of digits for the numerator or denominator, or the denominator of the formatted fraction. |
Enumeration: FractionOption
Fraction options.
| Property | Value | Description |
|---|---|---|
| Digits | 0 | Digits. |
| Denominator | 1 | Denominator. |
CIMLatLonFormat
Represents a latitude and longitude format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMNumericFormat
| Property | Type | Description |
|---|---|---|
| alignmentOption | enumeration esriNumericAlignmentEnum | The alignment option. |
| alignmentWidth | long | The alignment width. |
| roundingOption | enumeration esriRoundingOptionEnum | The rounding option. |
| roundingValue | long | The rounding value, whose meaning depends on the rounding option. |
| showPlusSign | boolean | A value indicating whether formatted numbers contain a plus sign for positive numbers. |
| useSeparator | boolean | A value indicating whether formatted numbers contain digit grouping symbols. |
| zeroPad | boolean | A value indicating whether formatted numbers contain padded zeros to the right of the decimal. |
CIMLatLonFormat
| Property | Type | Description |
|---|---|---|
| showDirections | boolean | A value indicating whether a directional letter (N-S-E-W) is appended to the formatted number. |
| isLatitude | boolean | A value indicating whether a formatted number is a latitude or not. |
| showZeroMinutes | boolean | A value indicating whether zero minutes are included in formatted output. |
| showZeroSeconds | boolean | A value indicating whether zero seconds are included in formatted output. |
Enumeration: NumericAlignment
Numeric alignment types.
| Property | Value | Description |
|---|---|---|
| AlignRight | 0 | Align right. |
| AlignLeft | 1 | Align left. |
CIMNumericFormat
Represents a numeric format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMNumericFormat
| Property | Type | Description |
|---|---|---|
| alignmentOption | enumeration esriNumericAlignmentEnum | The alignment option. |
| alignmentWidth | long | The alignment width. |
| roundingOption | enumeration esriRoundingOptionEnum | The rounding option. |
| roundingValue | long | The rounding value, whose meaning depends on the rounding option. |
| showPlusSign | boolean | A value indicating whether formatted numbers contain a plus sign for positive numbers. |
| useSeparator | boolean | A value indicating whether formatted numbers contain digit grouping symbols. |
| zeroPad | boolean | A value indicating whether formatted numbers contain padded zeros to the right of the decimal. |
CIMNumericFormatSuffix
| Property | Type | Description |
|---|---|---|
| suffix | string | The numeric suffix. |
CIMPercentageFormat
Represents a percentage format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMNumericFormat
| Property | Type | Description |
|---|---|---|
| alignmentOption | enumeration esriNumericAlignmentEnum | The alignment option. |
| alignmentWidth | long | The alignment width. |
| roundingOption | enumeration esriRoundingOptionEnum | The rounding option. |
| roundingValue | long | The rounding value, whose meaning depends on the rounding option. |
| showPlusSign | boolean | A value indicating whether formatted numbers contain a plus sign for positive numbers. |
| useSeparator | boolean | A value indicating whether formatted numbers contain digit grouping symbols. |
| zeroPad | boolean | A value indicating whether formatted numbers contain padded zeros to the right of the decimal. |
CIMPercentageFormat
| Property | Type | Description |
|---|---|---|
| adjustPercentage | boolean | A value indicating whether or not to adjust the percentage. |
CIMRateFormat
Represents a rate format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMNumericFormat
| Property | Type | Description |
|---|---|---|
| alignmentOption | enumeration esriNumericAlignmentEnum | The alignment option. |
| alignmentWidth | long | The alignment width. |
| roundingOption | enumeration esriRoundingOptionEnum | The rounding option. |
| roundingValue | long | The rounding value, whose meaning depends on the rounding option. |
| showPlusSign | boolean | A value indicating whether formatted numbers contain a plus sign for positive numbers. |
| useSeparator | boolean | A value indicating whether formatted numbers contain digit grouping symbols. |
| zeroPad | boolean | A value indicating whether formatted numbers contain padded zeros to the right of the decimal. |
CIMRateFormat
| Property | Type | Description |
|---|---|---|
| factor | double | The rate factor. |
| label | string | The label appended to the formatted rate number. |
Enumeration: RoundingOption
Rounding options.
| Property | Value | Description |
|---|---|---|
| NumberOfDecimals | 0 | Rounding by number of decimals. |
| NumberOfSignificantDigits | 1 | Rounding by number of significant digits. |
CIMScientificNumberFormat
Represents scientific number format.
CIMNumberFormat
| Property | Type | Description |
|---|
CIMScientificNumberFormat
| Property | Type | Description |
|---|---|---|
| decimalPlaces | long | The number of decimal places to show. |