Функция Format

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает строку, отформатированную в соответствии с инструкциями, содержащимися в формате выражения String.

Public Shared Function Format( _
   ByVal Expression As Object, _
   Optional ByVal Style As String = "" _
) As String

Параметры

Expression
Обязательный атрибут. Любое допустимое выражение.
Style
Необязательный атрибут. Правильно именованное или определенное пользователем выражение формата String.

Settings

Для получения сведений о создании аргумента Style см. соответствующий раздел, приведенный ниже:

Чтобы форматировать	Действия
Числа	Используйте стандартные числовые форматы или создайте пользовательские числовые форматы.
Дата и время	Используйте стандартные форматы даты и времени или создайте пользовательские форматы даты и времени.
Последовательности чисел даты и времени	Используйте форматы даты и времени или числовые форматы.

При попытке отформатировать число без указания Style функция Format предоставляет функциональные возможности, подобные функции Str, но с учетом региональных стандартов. Однако, положительные числа, форматируемые как строки с помощью функции Format, не имеют пространства в начале строки для знака значения, а преобразуемые с помощью функции Str сохраняют такое пространство.

Заметки

При форматировании нелокализованной числовой строки следует использовать числовой формат, определенный пользователем, чтобы гарантировать получение ожидаемого результата.

Метод String.Format также предоставляет аналогичные функциональные возможности.

Пример

В данном примере показаны различные способы использования функции Format для форматирования значений с применением как форматов String, так и определенных пользователем форматов. Фактическое отображение системой разделителя даты (/), разделителя времени (: и индикаторов AM/PM (t и tt) зависит от региональных параметров, применяемых кодом. При отображении времени и даты в среде разработки используется короткий формат времени и даты региональных установок кода.

Примечание.
Для языков, использующих 24-часовой формат, индикаторы AM/PM (t и tt) не отображаются.

Dim TestDateTime As Date = #1/27/2001 5:04:23 PM#
Dim TestStr As String
' Returns current system time in the system-defined long time format.
TestStr = Format(Now(), "Long Time")
' Returns current system date in the system-defined long date format.
TestStr = Format(Now(), "Long Date")
' Also returns current system date in the system-defined long date 
' format, using the single letter code for the format.
TestStr = Format(Now(), "D")

' Returns the value of TestDateTime in user-defined date/time formats.
' Returns "5:4:23".
TestStr = Format(TestDateTime, "h:m:s")
' Returns "05:04:23 PM".
TestStr = Format(TestDateTime, "hh:mm:ss tt")
' Returns "Saturday, Jan 27 2001".
TestStr = Format(TestDateTime, "dddd, MMM d yyyy")
' Returns "17:04:23".
TestStr = Format(TestDateTime, "HH:mm:ss")
' Returns "23".
TestStr = Format(23)

' User-defined numeric formats.
' Returns "5,459.40".
TestStr = Format(5459.4, "##,##0.00")
' Returns "334.90".
TestStr = Format(334.9, "###0.00")
' Returns "500.00%".
TestStr = Format(5, "0.00%")