Gambas/functions/Format - Revision history

Woozle: relevant internal link

2015-05-14T11:42:30Z

relevant internal link

← Older revision		Revision as of 11:42, 14 May 2015
Line 4:		Line 4:
	''String'' = {{l/same\|Format}} ( ''Expression'' [ , ''Format'' ] )		''String'' = {{l/same\|Format}} ( ''Expression'' [ , ''Format'' ] )
	* '''See also''':		* '''See also''':
	** ''String'' = {{l/same\|CStr}}(''expression'') - converts ''expression'' to a ''string'' in the default format		** ''String'' = {{l/same\|CStr}}(''expression'') - [[Gambas/syntax/variables/type conversion\|converts]] ''expression'' to a ''string'' in the default format
	==Action==		==Action==
	Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).		Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).

Woozle: Woozle moved page Gambas/reference/Format to Gambas/functions/Format: one more time...

2013-04-24T20:28:15Z

Woozle moved page Gambas/reference/Format to Gambas/functions/Format: one more time...

← Older revision	Revision as of 20:28, 24 April 2013
(No difference)

Woozle: post-move reformatting

2013-04-24T20:05:26Z

post-move reformatting

← Older revision		Revision as of 20:05, 24 April 2013
Line 1:		Line 1:
	~~{{Gambas article\|Format}}~~{{boxright\|__TOC__}}		{{boxright\|__TOC__}}
	==Usage==		==Usage==
	''String'' = ~~[[Format (Gambas)~~\|Format]]$ ( ''Expression'' [ , ''Format'' ] )		''String'' = {{l/same\|Format}}$ ( ''Expression'' [ , ''Format'' ] )
	''String'' = ~~[[Format (Gambas)~~\|Format]] ( ''Expression'' [ , ''Format'' ] )		''String'' = {{l/same\|Format}} ( ''Expression'' [ , ''Format'' ] )
	* '''See also''':		* '''See also''':
	** ''String'' = ~~[[CStr (Gambas)~~\|CStr]](''expression'') - converts ''expression'' to a ''string'' in the default format		** ''String'' = {{l/same\|CStr}}(''expression'') - converts ''expression'' to a ''string'' in the default format
	==Action==		==Action==
	Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).		Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).

Woozle: Woozle moved page Format (Gambas) to Gambas/reference/Format: reorganizing

2013-04-24T20:03:19Z

Woozle moved page Format (Gambas) to Gambas/reference/Format: reorganizing

← Older revision	Revision as of 20:03, 24 April 2013
(No difference)

Woozle: moved copying note to the end; some additional cleanup

2006-01-08T20:51:52Z

moved copying note to the end; some additional cleanup

← Older revision		Revision as of 20:51, 8 January 2006
Line 1:		Line 1:
	{{Gambas article\|Format}}{{boxright\|__TOC__}}		{{Gambas article\|Format}}{{boxright\|__TOC__}}
	~~==Note==~~
	* Much of this text has been copied from [http://www.gambasdoc.org/help/lang/format here], which is presumed to be available under a GNU-compatible license.
	==Usage==		==Usage==
	''String'' = [[Format (Gambas)\|Format]]$ ( ''Expression'' [ , ''Format'' ] )		''String'' = [[Format (Gambas)\|Format]]$ ( ''Expression'' [ , ''Format'' ] )
	''String'' = [[Format (Gambas)\|Format]] ( ''Expression'' [ , ''Format'' ] )		''String'' = [[Format (Gambas)\|Format]] ( ''Expression'' [ , ''Format'' ] )
	==See ~~Also==~~		* '''See also''':
	* [[CStr (Gambas)\|CStr]]		** ''String'' = [[CStr (Gambas)\|CStr]](''expression'') - converts ''expression'' to a ''string'' in the default format
	==Action==		==Action==
	Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).		Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).
Line 113:		Line 111:
	{\|		{\|
	\|-		\|-
	\|'''gb.GeneralNumber'''\|\|~~Write a number with~~ twelve decimal digits~~. Use~~ scientific format if ~~its~~ absolute value is lower than 10{{exp\|-4}} or greater than 10{{exp\|7}}.		\|'''gb.GeneralNumber'''\|\| Use twelve decimal digits, or scientific format if the absolute value is lower than 10{{exp\|-4}} or greater than 10{{exp\|7}}.
	\|-		\|-
	\|'''gb.Fixed'''\|\|Equivalent to "0.00"		\|'''gb.Fixed'''\|\| Equivalent to "0.00"
	\|-		\|-
	\|'''gb.Percent'''\|\|Equivalent to "###%"		\|'''gb.Percent'''\|\| Equivalent to "###%"
	\|-		\|-
	\|'''gb.Scientific'''\|\|~~Write a number with its~~ exponent and eighteen decimal digits.		\|'''gb.Scientific'''\|\| Use an exponent and eighteen decimal digits.
	\|}		\|}

Line 151:		Line 149:
	\|'''gb.Standard'''\|Use '''gb.GeneralNumber''' for formatting numbers and '''gb.GeneralDate''' for formatting dates and times.		\|'''gb.Standard'''\|Use '''gb.GeneralNumber''' for formatting numbers and '''gb.GeneralDate''' for formatting dates and times.
	\|}		\|}
			==Source==
			* Much of this text has been copied from [http://www.gambasdoc.org/help/lang/format here], which is presumed to be available under a GNU-compatible license.

Woozle at 20:47, 8 January 2006

2006-01-08T20:47:22Z

New page

{{Gambas article|Format}}{{boxright|__TOC__}}
==Note==
* Much of this text has been copied from [http://www.gambasdoc.org/help/lang/format here], which is presumed to be available under a GNU-compatible license.
==Usage==
''String'' = [[Format (Gambas)|Format]]$ ( ''Expression'' [ , ''Format'' ] )
''String'' = [[Format (Gambas)|Format]] ( ''Expression'' [ , ''Format'' ] )
==See Also==
* [[CStr (Gambas)|CStr]]
==Action==
Converts an ''expression'' to a ''string'' based on the given ''format''. The format may be either user-defined or one of several pre-defined formats. If ''format'' is not specified, '''gb.Standard''' is used (see [[#general]]).
* Localization settings may affect the output of this function.
==User-Defined Formats==
===numeric===
{|
|-
| '''+''' || Prints the sign of the number.
|-
| '''-''' || Prints the sign of the number only if it is negative.
|-
| '''#''' || Prints a digit only if necessary.
|-
| '''0''' || Always prints a digit, padding with a zero if necessary.
|-
| '''.''' || Prints the decimal separator.
|-
| ''',''' || Prints the thousand separators.
|-
| '''%''' || Multiplies the number by 100 and prints a per-cent sign.
|-
| '''E''' || Introduces the exponential part of a Float number. The sign of the exponent is always printed.
|}
====Examples====
{|
|-
|PRINT Format$(Pi, "-#.###")||3.142
|-
|PRINT Format$(Pi, "+0#.###0")||+03.1416
|-
|PRINT Format$(Pi / 10, "###.# %")||31.4 %
|-
|PRINT Format$(-11 ^ 11, "#.##E##")||-2.85E+11
|}
===currency===
{|
|-
| '''$''' || Prints the national currency symbol.
|-
| '''$$''' || When the $ is doubled, the international currency symbol is printed instead.
|-
| '''(''' ''f'' ''')''' || Designates the representation of negative currencies, where ''f'' is the format specifier
|}
====Examples====
{|
|-
| PRINT Format$(1972.06, "$#.###") || $1972.06
|-
| PRINT Format$(-1972.06, "$,#.###") || -$1,972.06
|-
| PRINT Format$(-1972.06, "($,#.###)") || ($1,972.06)
|}
===dates===
{|
|-
| '''yy''' || Prints the year on two digits.
|-
| '''yyyy''' || Prints the year on four digits.
|-
| '''m''' || Prints the month.
|-
| '''mm''' || Prints the month on two digits.
|-
| '''mmm''' || Prints the month in an abbreviatted string form.
|-
| '''mmmm''' || Prints the month in its full string form.
|-
| '''d''' || Prints the day.
|-
| '''dd''' || Prints the day on two digits.
|-
| '''ddd''' || Prints the week day in an abbreviated form.
|-
| '''dddd''' || Prints the week day in its full form.
|-
| '''/''' || Prints the date separator.
|-
| '''h''' || Prints the hour.
|-
| '''hh''' || Prints the hour on two digits.
|-
| '''n''' || Prints the minutes.
|-
| '''nn''' || Prints the minutes on two digits.
|-
| '''s''' || Prints the seconds.
|-
| '''ss''' || Prints the seconds on two digits.
|-
| ''':''' || Prints the time separator.
|}
====Examples====
{|
|-
| PRINT Format$(Now, "mm/dd/yyyy hh:nn:ss") || 04/15/2002 09:05:36
|-
| PRINT Format$(Now, "m/d/yy h:n:s") || 4/15/02 9:5:36
|-
| PRINT Format$(Now, "ddd dd mmm yyyy") || Mon Apr 15 2002
|-
| PRINT Format$(Now, "dddd dd mmmm yyyy") || Monday April 15 2002
|}
==Pre-Defined Formats==
===Numeric===
{|
|-
|'''gb.GeneralNumber'''||Write a number with twelve decimal digits. Use scientific format if its absolute value is lower than 10{{exp|-4}} or greater than 10{{exp|7}}.
|-
|'''gb.Fixed'''||Equivalent to "0.00"
|-
|'''gb.Percent'''||Equivalent to "###%"
|-
|'''gb.Scientific'''||Write a number with its exponent and eighteen decimal digits.
|}

===date and time===
{|
|-
|'''gb.GeneralDate'''||Write a date only if the date and time value has a date part, and write a time only if it has a date part.
|-
|'''gb.LongDate'''||Long date format.
|-
|'''gb.MediumDate'''||Medium date format.
|-
|'''gb.ShortDate'''||Short date format.
|-
|'''gb.LongTime'''||Long time format.
|-
|'''gb.MediumTime'''||Medium time format.
|-
|'''gb.ShortTime'''||Short time format.
|}
===currency===
{|
|-
|'''gb.Currency'''||Format a currency by using the national currency symbol.
|-
|'''gb.International'''||Format a currency by using the international currency symbol.
|}
===general===
{|
|-
|'''gb.Standard'''|Use '''gb.GeneralNumber''' for formatting numbers and '''gb.GeneralDate''' for formatting dates and times.
|}