TextBox.Format
Usage:
Description:
Specifies format used to display the value.
This is a string including formatting options.
If a parameter is not set, standard formatting (which generally works as conversion of value to string) is used. However, for Number or Date type values by default (0 and 01.01.0001 00:00:00 respectively) it will return a representation of a zero value in format of the text box or date mask according to regional settings of the information base.
Formatting parameters are separated with a ";" character. If a parameter has a non-empty value it means that formatting is not standard. Standard formatting mainly corresponds to transformation of a value into string.
To set each parameter of a format string you have to use name of the parameter, "=" symbol and value of the parameter. You can specify the parameter value in quotes or double quotes. It is necessary when the value of the parameter contains symbols used in syntax of the format string. You can specify arbitrary symbols within the parameter value. When the resulting string is formed, these symbols will be displayed "as is". This way you can specify the hour, minute and second separators for time formatting. If these symbols are the same as the format string values, you must place them in single quotes.
Names and values of format string parameters:
- L - Language and country name for which standard formatting will be executed. Available language names:
- af Afrikaans
- af_NA Afrikaans (Namibia)
- af_ZA Afrikaans (South Africa)
- am Amharic
- am_ET Amharic (Ethiopia)
- ar Arabic
- ar_AE Arabic (United Arab Emirates)
- ar_BH Arabic (Bahrain)
- ar_DZ Arabic (Algeria)
- ar_EG Arabic (Egypt)
- ar_IQ Arabic (Iraq)
- ar_JO Arabic (Jordan)
- ar_KW Arabic (Kuwait)
- ar_LB Arabic (Lebanon)
- ar_LY Arabic (Libya)
- ar_MA Arabic (Morocco)
- ar_OM Arabic (Oman)
- ar_QA Arabic (Qatar)
- ar_SA Arabic (Saudi Arabia)
- ar_SD Arabic (Sudan)
- ar_SY Arabic (Syria)
- ar_TN Arabic (Tunisia)
- ar_YE Arabic (Yemen)
- as Assamese
- as_IN Assamese (India)
- az Azerbaijani
- az_AZ Azerbaijani (Azerbaijan)
- az_Cyrl Azerbaijani (Cyrillic)
- az_Cyrl_AZ Azerbaijani (Cyrillic, Azerbaijan)
- az_Latn Azerbaijani (Latin)
- az_Latn_AZ Azerbaijani (Latin, Azerbaijan)
- be Belarusian
- be_BY Belarusian (Belarus)
- bg Bulgarian
- bg_BG Bulgarian (Bulgaria)
- bn Bengali
- bn_IN Bengali (India)
- ca Catalan
- ca_ES Catalan (Spain)
- cs Czech
- cs_CZ Czech (Czech Republic)
- cy Welsh
- cy_GB Welsh (United Kingdom)
- da Danish
- da_DK Danish (Denmark)
- de German
- de_AT German (Austria)
- de_BE German (Belgium)
- de_CH German (Switzerland)
- de_DE German (Germany)
- de_LI German (Liechtenstein)
- de_LU German (Luxembourg)
- el Greek
- el_CY Greek (Cyprus)
- el_GR Greek (Greece)
- en English
- en_AU English (Australia)
- en_BE English (Belgium)
- en_BW English (Botswana)
- en_BZ English (Belize)
- en_CA English (Canada)
- en_GB English (United Kingdom)
- en_HK English (Hong Kong S.A.R., China)
- en_IE English (Ireland)
- en_IN English (India)
- en_JM English (Jamaica)
- en_MH English (Marshall Islands)
- en_MT English (Malta)
- en_NA English (Namibia)
- en_NZ English (New Zealand)
- en_PH English (Philippines)
- en_PK English (Pakistan)
- en_SG English (Singapore)
- en_TT English (Trinidad and Tobago)
- en_US English (United States)
- en_VI English (U.S. Virgin Islands)
- en_ZA English (South Africa)
- en_ZW English (Zimbabwe)
- es Spanish
- es_AR Spanish (Argentina)
- es_BO Spanish (Bolivia)
- es_CL Spanish (Chile)
- es_CO Spanish (Colombia)
- es_CR Spanish (Costa Rica)
- es_DO Spanish (Dominican Republic)
- es_EC Spanish (Ecuador)
- es_ES Spanish (Spain)
- es_GT Spanish (Guatemala)
- es_HN Spanish (Honduras)
- es_MX Spanish (Mexico)
- es_NI Spanish (Nicaragua)
- es_PA Spanish (Panama)
- es_PE Spanish (Peru)
- es_PR Spanish (Puerto Rico)
- es_PY Spanish (Paraguay)
- es_SV Spanish (El Salvador)
- es_US Spanish (United States)
- es_UY Spanish (Uruguay)
- es_VE Spanish (Venezuela)
- et Estonian
- et_EE Estonian (Estonia)
- eu Basque
- eu_ES Basque (Spain)
- fa Persian
- fa_AF Persian (Afghanistan)
- fa_IR Persian (Iran)
- fi Finnish
- fi_FI Finnish (Finland)
- fo Faroese
- fo_FO Faroese (Faroe Islands)
- fr French
- fr_BE French (Belgium)
- fr_CA French (Canada)
- fr_CH French (Switzerland)
- fr_FR French (France)
- fr_LU French (Luxembourg)
- fr_MC French (Monaco)
- fr_SN French (Senegal)
- ga Irish
- ga_IE Irish (Ireland)
- gl Gallegan
- gl_ES, Gallegan (Spain)
- gu Gujarati
- gu_IN Gujarati (India)
- he Hebrew
- he_IL Hebrew (Israel)
- hi Hindi
- hi_IN Hindi (India)
- hr Croatian
- hr_HR Croatian (Croatia)
- hu Hungarian
- hu_HU Hungarian (Hungary)
- hy Armenian
- hy_AM Armenian (Armenia)
- hy_AM_REVISED Armenian (Armenia, Revised Orthography)
- id Indonesian
- id_ID Indonesian (Indonesia)
- is Icelandic
- is_IS Icelandic (Iceland)
- it Italian
- it_CH, Italian (Switzerland)
- it_IT Italian (Italy)
- ja Japanese
- ja_JP Japanese (Japan)
- ka Georgian
- ka_GE Georgian (Georgia)
- kk Kazakh
- kk_KZ Kazakh (Kazakhstan)
- kl Kalaallisut
- kl_GL Kalaallisut (Greenland)
- kn Kannada
- kn_IN Kannada (India)
- ko Korean
- ko_KR Korean (South Korea)
- kok Konkani
- kok_IN Konkani (India)
- ky Kirghiz
- ky_KY Kirghiz (Kyrgyzstan)
- lt Lithuanian
- lt_LT Lithuanian (Lithuania)
- lv Latvian
- lv_LV Latvian (Latvia)
- mk Macedonian
- mk_MK Macedonian (Macedonia)
- ml Malayalam
- ml_IN Malayalam (India)
- mr Marathi
- mr_IN Marathi (India)
- ms Malay
- ms_BN Malay (Brunei)
- ms_MY Malay (Malaysia)
- mt Maltese
- mt_MT Maltese (Malta)
- nb Norwegian Bokmel
- nb_NO Norwegian Bokmel (Norway)
- nl Dutch
- nl_BE Dutch (Belgium)
- nl_NL Dutch (Netherlands)
- nn Norwegian Nynorsk
- nn_NO Norwegian Nynorsk (Norway)
- om Oromo
- om_ET Oromo (Ethiopia)
- om_KE Oromo (Kenya)
- or Oriya
- or_IN Oriya (India)
- pa Punjabi
- pa_IN Punjabi (India)
- pl Polish
- pl_PL Polish (Poland)
- ps Pashto (Pushto)
- ps_AF Pashto (Pushto) (Afghanistan)
- pt Portuguese
- pt_BR Portuguese (Brazil)
- pt_PT Portuguese (Portugal)
- ro Romanian
- ro_RO Romanian (Romania)
- ru Russian
- ru_RU Russian (Russia)
- ru_UA Russian (Ukraine)
- sk Slovak
- sk_SK Slovak (Slovakia)
- sl Slovenian
- sl_SI Slovenian (Slovenia)
- so Somali
- so_DJ Somali (Djibouti)
- so_ET Somali (Ethiopia)
- so_KE Somali (Kenya)
- so_SO Somali (Somalia)
- sq Albanian
- sq_AL Albanian (Albania)
- sr Serbian
- sr_BA Serbian (Bosnia And Herzegovina)
- sr_CS Serbian (Serbia And Montenegro)
- sr_Cyrl Serbian (Cyrillic)
- sr_Cyrl_BA Serbian (Cyrillic, Bosnia And Herzegovina)
- sr_Cyrl_CS Serbian (Cyrillic, Serbia And Montenegro)
- sr_Cyrl_ME Serbian (Cyrillic, Montenegro)
- sr_Cyrl_RS Serbian (Cyrillic, Serbia)
- sr_Latn Serbian (Latin)
- sr_Latn_BA Serbian (Latin, Bosnia And Herzegovina)
- sr_Latn_CS Serbian (Latin, Serbia And Montenegro)
- sr_Latn_ME Serbian (Latin, Montenegro)
- sr_Latn_RS Serbian (Latin, Serbia)
- sr_ME Serbian (Montenegro)
- sr_RS Serbian (Serbia)
- sv Swedish
- sv_FI Swedish (Finland)
- sv_SE Swedish (Sweden)
- sw Swahili
- sw_KE Swahili (Kenya)
- sw_TZ Swahili (Tanzania)
- ta Tamil
- ta_IN Tamil (India)
- te Telugu
- te_IN Telugu (India)
- th Thai
- th_TH Thai (Thailand)
- ti Tigrinya
- ti_ER Tigrinya (Eritrea)
- ti_ET Tigrinya (Ethiopia)
- tr Turkish
- tr_TR Turkish (Turkey)
- uk Ukrainian
- uk_UA Ukrainian (Ukraine)
- ur Urdu
- ur_PK Urdu (Pakistan)
- uz Uzbek
- uz_Cyrl Uzbek (Cyrillic)
- uz_Cyrl_UZ Uzbek (Cyrillic, Uzbekistan)
- uz_Latn Uzbek (Latin)
- uz_Latn_UZ Uzbek (Latin, Uzbekistan)
- uz_UZ Uzbek (Uzbekistan)
- vi Vietnamese
- vi_VN Vietnamese (Vietnam)
- zh Chinese
- zh_CN Chinese (China)
- zh_Hans Chinese (Simplified Han)
- zh_Hans_CN Chinese (Simplified Han, China)
- zh_Hans_SG Chinese (Simplified Han, Singapore)
- zh_Hant Chinese (Traditional Han)
- zh_Hant_HK Chinese (Traditional Han, Hong Kong S.A.R., China)
- zh_Hant_MO Chinese (Traditional Han, Macao S.A.R., China)
- zh_Hant_TW Chinese (Traditional Han, Taiwan)
- zh_HK Chinese (Hong Kong S.A.R., China)
- zh_MO Chinese (Macao S.A.R., China)
- zh_SG Chinese (Singapore)
- zh_TW Chinese (Taiwan)
- ND - Total number of displayed fraction digits of the integer part. The source number is rounded off in accordance with the rounding-off rules set for configuration. If this parameter is specified, it is necessary to specify the NFD parameter so fraction digits are displayed; otherwise fraction digits will not be displayed.
- NFD - Number of fraction digits in fraction part. The source number is rounded off in accordance with the rounding-off rules set for configuration.
- NDS - Separator of integer and fraction digits.
- NGS - Separator of integer and fraction digits groups. When separator is set to an empty string, non-breaking space is used as a separator.
- NG - Number digits group order. As a value, the numbers specified by comma denote the quantity of grouped digits from right to left.Only the first two numbers are significant. The first number defines the initial grouping, which is applied to the least significant digits of the integer part. If the second number is not specified, only the least significant digits are grouped. If the second number is 0, the initial grouping is applied to all digits of the integer part. If the second number is not 0, this number is used for grouping all digits except the least significant ones that were grouped first.
- NN - Negative number representation.
- 0 - a string of " (1.1)" type;
- 1 - a string of " "-1.1" type;
- 2 - a string of "-1.1" type;
- 3 - a string of "1.1-" type;
- 4 - a string of "1.1 -" type.
- DF - Date format:
- d - date (digits) without leading zero;
- dd - date (digits) with a leading zero;
- M - month number (digits) without a leading zero;
- MM - month number (digits) with a leading zero;
- q - quarter number per year;
- y - year number without the century and a leading zero;
- yy - year number without the century with a leading zero;
- yyyy - year number with the century;
- h - an hour in the 12-hour format without leading zeros;
- hh - an hour in the 12-hour format with leading zeros;
- H - an hour in the 24-hour format without leading zeros;
- HH - an hour in the 24-hour format with a leading zero;
- m - a minute without a leading zero;
- mm - a minute with a leading zero;
- s - a second without a leading zero;
- ss - a second with a leading zero;
- tt - AM/PM display (valid only for configuration languages supporting the 12-hour format for displaying time).
- DLF - Local date format. You may use this to specify the date part display format.
- D - date (in digits);
- DD - full date (full name of month);
- T - full time, date can be combined with time,
- DT - date time.
- Example: Format('20051120140323',"DLF=DDT") = "Sunday, November 20, 2005 2:03:23 PM".
- Important! You can not change the order of format string options for DLF "date + time" ("D + T" or "DD + T").
- DE - Representation format for empty date (DE=01.01.0001), empty time (DE=00:00:00) or date and time (DE=01.01.0001 0:00:00). The parameter value should strictly correspond to the rules of date format depending on the information base locales regional settings.
Availability:
Note: