_Application2.FormatString(Object, String, String) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Форматирует заданную строку или узел XML в соответствии с указанными категорией и параметрами.
public:
System::String ^ FormatString(System::Object ^ varInput, System::String ^ bstrCategory, System::String ^ bstrOptions);
public string FormatString (object varInput, string bstrCategory, string bstrOptions);
abstract member FormatString : obj * string * string -> string
Public Function FormatString (varInput As Object, bstrCategory As String, bstrOptions As String) As String
Параметры
- varInput
- Object
Форматируемые значение или узел XML.
- bstrCategory
- String
Значение, определяющее категорию, используемую для форматирования. Значение включает число, процент, валюту, дату, время и дату/время.
- bstrOptions
- String
Значение, определяющее параметры, используемые при форматировании. Принимает форму чувствительной к регистру строки в формате "optionName:value".
Возвращаемое значение
Строка (string), отформатированная в соответствие с указанной категорией и параметрами.
Реализации
Примеры
В следующем примере метод ApplicationFormatString объекта используется для форматирования указанной строки даты в длинный формат даты:
thisApplication.<span class="label">FormatString</span>("2003-01-08", "date", "dateFormat:Long Date");
Комментарии
Метод FormatString можно использовать везде, где требуется изменить формат заданной строки. Он должен быть снабжен именем приложения, а его значение возврата необходимо назначить переменной или использовать как выражение, требующее строкового значения.
В следующих разделах перечислены значения, которые могут использоваться для bstrCategory
и bstrOptions
:
Список категорий
число | Использует числовые значения. Допустимыми параметрами для этой категории являются "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" и "negativeOrder". |
Процент | Использует процентные значения. Допустимыми параметрами для этой категории являются "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" и "negativeOrder". |
currency | Использует значения валют. Допустимыми параметрами для этой категории являются: "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" и "negativeOrder", "positiveOrder", and "currencyLocale". |
дата | Использует значения дат. Допустимыми параметрами для этой категории являются "locale", "dateFormat", "useAltCalendar" и "useEnglishStringsAlways". |
time | Использует значения времени. Допустимыми параметрами для этой категории являются "locale", "timeFormat", and "noSeconds". |
datetime | Использует значения даты и времени. Допустимыми параметрами для этой категории будут "locale", "dateFormat", "timeFormat", "noSeconds", "useAltCalendar" и "useEnglishStringAlways". |
Список параметров
locale | Задает идентификатор языка (LCID). По умолчанию устанавливается LCID текущего пользователя (если не указан). |
numDigits | Задает количество знаков после дробной запятой. Может также использоваться автоматическое значение, указывающее, что количество введенных знаков после дробной запятой будет совпадать с количеством знаков после дробной запятой в выходных данных. Например 1,234, 1,234, 1,00, 1,00, 1,56e2 или 156,00. По умолчанию устанавливается соответствующее значение в региональных параметрах (если не определено). |
leadingZero | Указывает, следует ли использовать начальные нули в десятичных полях. Значение 0 отменяет начальные нули, а значение 1 означает их присутствие. По умолчанию устанавливается соответствующее значение из региональных параметров (если не определено). |
Группировки | Задает размер каждой группы знаков слева от десятичной запятой. Значения в диапазоне 0–9 и значение 32 являются допустимыми. Значение 32 означает, что группировка идет по три знака, и два знака после запятой. По умолчанию устанавливается соответствующее значение из региональных параметров (если не определено). |
decimalSep | Задает строку с десятичной запятой. По умолчанию устанавливается соответствующее значение из региональных параметров (если не определено). |
thousandSep | Задает строку разделителя разрядов тысяч. По умолчанию устанавливается соответствующее значение из региональных параметров (если не определено). |
negativeOrder | Задает режим отрицательных чисел. По умолчанию устанавливается соответствующее значение из региональных параметров (если не определено). |
positiveOrder | Задает режим положительных чисел. По умолчанию устанавливается соответствующее значение из региональных параметров (если не определено). |
currencyLocale | Задает идентификатор языка (LCID) для текущего символа. По умолчанию устанавливается значение, указанное языком (если не определено). |
dateFormat | Задает строку с картинкой формата, используемой для формирования строки даты. Также можно использовать значения "Краткая дата", "Длинная дата", "Год месяц" и "нет", чтобы обозначить краткий формат даты, длинный формат даты, формат месяц — год и отсутствие формата соответственно. "Краткая дата", "Длинная дата" и "Год месяц" являются форматами по умолчанию, указанными в региональных и языковых параметрах операционной системы. |
useAltCalendar | Указывает, следует ли использовать альтернативный календарь для форматов дат. Значение 0 обозначает использование стандартного календаря, а значение 1 — альтернативного. По умолчанию устанавливается значение 0 (если не определено). |
useEnglishStringsAlways | Указывает, следует ли всегда использовать строки на английском языке для форматов дат. Если задать значение 0, будет использоваться язык, указанный национальной настройкой, а если задать значение 1, то всегда будет использоваться английский язык. По умолчанию устанавливается значение 0 (если не определено). |
TimeFormat | Задает строку формата, используемую для формирования строки времени. Можно использовать значение "нет", чтобы обозначить отсутствие формата. По умолчанию устанавливается формат времени из региональных параметров (если не определено). |
noSeconds | Указывает, следует ли использовать секунды. Значение 0 обозначает использование секунд, а значение 1 их отсутствие. По умолчанию устанавливается значение 0 (если не определено). |