![]() |
FormatString








Public Data Item |
Declared in: NiAxis3d.h |
Declaration
CString FormatString;
Description
Specifies the format string for formatting the labels on this axis.
Notes:
1. The formatting characters listed below are available.
- .(decimal point) - specifies the beginning of the number within the label. Use # and 0 to the right of the decimal point to specify the precision. If you do not include a decimal point in the format string, a decimal point is assumed to be the first character in the format string.
- 0 - specifies the precise precision to the right of the decimal point. For example, ".#0" always produces two digits to the right of the decimal point, even when given an exact number such as 1.0.
- # - specifies the approximate precision to the right of the decimal point. For example, ".##" produces up to two digits to the right of the decimal point. Thus, 1.0 produces 1, while 1.025 produces 1.03.
- e,E - specifies exponential notation. "E" specifies the capital letter, while "e" specifies the lowercase letter.
- *nn - scales labels. For example, ".*10" prints the value 1.0 as 10.
- +nn or -nn - offsets labels. For example ".+20" prints the value 1.0 as 21.
- k - specifies symbolic notation. For the format string ".k", 1.0 prints as 1, 1000 prints as 1k, and .001 prints as 1m.
- "text" - specifies to add text to the label. For example, '."V"' adds a V to the right of every label. Thus, 1.0 becomes 1 V.
- $, % - specifies to print these special characters.
- : (colon) - time separator. The time separator separates hours, minutes, and seconds when time values are formatted.
- / - date separator. The date separator separates the day, month, and year when date values are formatted.
- d - display the day as a number without a leading zero (1-31).
- dd - displays the day as a number with a leading zero (01-31).
- ddd - displays the day as an abbreviation (Sun - Sat).
- dddd - displays the day as a full name (Sunday - Saturday).
- w - displays the day of the week as a number (1 for Sunday through 7 for Saturday).
- ww - displays the week of the year as a number (1-53).
- m - displays the month as a number without a leading zero (1 - 12).
- mm - displays the month as a number with a leading zero (01 - 12).
- mmm - displays the month as an abbreviation (Jan - Dec).
- mmmm - displays the month as a full month name (January December).
- q - displays the quarter of the year as a number (1 - 4).
- y - displays the day of the year as a number (1 - 366).
- yy - displays the year as a 2-digit number (00 - 99).
- yyyy - displays the year as a 4-digit number (1000 - 9999).
- h - displays the hour as a number without leading zeros (0 - 23).
- hh - displays the hour as a number with leading zeros (00 - 23).
- n - Displays the minute as a number without leading zeros (0 - 59).
- nn - displays the minute as a number with leading zeros (00 - 59).
- s - displays the second as a number without leading zeros (0 - 59).
- ss - displays the second as a number with leading zeros (00 - 59).
- AM/PM - uses the 12-hour clock and displays an uppercase AM with any hour before noon; displays an uppercase PM with any hour between noon and 11:59 PM.
- am/pm - uses the 12-hour clock and displays a lowercase am with any hour before noon; displays a lowercase pm with any hour between noon and 11:59 pm.
- A/P - uses the 12-hour clock and displays an uppercase A with any hour before noon; displays an uppercase P with any hour between noon and 11:59 PM.
- a/p- uses the 12-hour clock and displays a lowercase a with any hour before noon; displays a lowercase p with any hour between noon and 11:59 pm.
2. If you select a format string that includes date or time formatting, the property pages display all values in a generic date and time format for editing.
3. See the CNiAxis3D overview for information about using date/time values.