NSMassFormatter

NSMassFormatter класс предоставляет должным образом отформатированные, локализованные описания значений веса и массы. Используйте этот класс для создания локализованных массовых строк при отображении массовой информации пользователям.

Наследование

NSObject
NSFormatter
NSMassFormatter

NSObject
NSFormatter
NSMassFormatter

Соответствует

AnyObject
CVarArgType
Сопоставимый
Hashable
NSCoding
NSCopying
NSObjectProtocol
Печатаемый
NSCoding
NSCopying
NSObject

Оператор импорта

Swift

import Foundation

Objective C

@import Foundation;

Доступность

Доступный в OS X v10.10 и позже.

Форматирование массовых строк

forPersonMassUse forPersonMassUse Свойство

Булево значение, указывающее, представляет ли получившая строка массу лица.

Объявление

Swift

var forPersonMassUse: Bool

Objective C

@property(getter=isForPersonMassUse) BOOL forPersonMassUse

Обсуждение

YEStrue, если значение передало stringFromKilograms: или unitStringFromKilograms:usedUnit: масса лица; иначе, NOfalse. Это свойство значения по умолчанию к NOfalse.

Массовое средство форматирования использует это свойство при определении лучшего модуля для данной локали (например, в stringFromKilograms: метод).

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.


    
    getObjectValue (_: forString:errorDescription:)
    - getObjectValue:forString:errorDescription:

Этот метод не поддерживается для NSMassFormatter класс.

Объявление

Swift

func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer<AnyObject?>, forString string: String, errorDescription error: AutoreleasingUnsafeMutablePointer<NSString?>) -> Bool

Objective C

- (BOOL)getObjectValue:(out id *)obj forString:(NSString *)string errorDescription:(out NSString **)error

Параметры

`obj`	Выходной параметр. Если переопределено, этот параметр должен содержать объект, создаваемый из предоставленной строки.
`string`	Строковое представление объекта.
`error`	Выходной параметр. Если переопределено, этот параметр должен содержать описание любых происходящих ошибок. Если Вы не хотите получать сообщения об ошибках, установите этот параметр на `NULL`.

Возвращаемое значение

YEStrue если преобразование из строки было успешно; иначе, NOfalse.

Обсуждение

Можно переопределить этот метод в подклассе. Для получения дополнительной информации см. Ссылку класса NSFormatter.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.

См. также

– getObjectValue:forString:errorDescription:

numberFormatter numberFormatter Свойство

Средство форматирования числа раньше форматировало числа в строках массы.

Объявление

Swift

@NSCopying var numberFormatter: NSNumberFormatter!

Objective C

@property(copy) NSNumberFormatter *numberFormatter

Обсуждение

Это свойство значения по умолчанию к средству форматирования числа с помощью NSNumberFormatterDecimalStyle стиль. Можно обеспечить различное средство форматирования числа для настройки появления массовой строки.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.
stringFromKilograms (_:) - stringFromKilograms:

Возвращает массовую строку для предоставленного значения.

Объявление

Swift

func stringFromKilograms(_ numberInKilograms: Double) -> String

Objective C

- (NSString *)stringFromKilograms:(double)numberInKilograms

Параметры

numberInKilograms

Значение массы в килограммах.

Возвращаемое значение

Строка, комбинирующая значение и строку модуля, подходящую для локали средства форматирования.

Обсуждение

Этот метод преобразовывает предоставленную массу в килограммах в модули, подходящие для локали средства форматирования.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.


    
    stringFromValue (_: модуль:)
    - stringFromValue:unit:

Возвращает должным образом отформатированную массовую строку для данного значения и модуля.

Объявление

Swift

func stringFromValue(_ value: Double, unit unit: NSMassFormatterUnit) -> String

Objective C

- (NSString *)stringFromValue:(double)value unit:(NSMassFormatterUnit)unit

Параметры

`value`	Значение массы в данном модуле.
`unit`	Модуль используется в получающейся массовой строке.

Возвращаемое значение

Локализованная строка, комбинирующая предоставленное значение и модуль.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.


    
    unitStringFromKilograms (_: usedUnit:)
    - unitStringFromKilograms:usedUnit:

Возвращает строку модуля для предоставленного значения.

Объявление

Swift

func unitStringFromKilograms(_ numberInKilograms: Double, usedUnit unitp: UnsafeMutablePointer<NSMassFormatterUnit>) -> String

Objective C

- (NSString *)unitStringFromKilograms:(double)numberInKilograms usedUnit:(NSMassFormatterUnit *)unitp

Параметры

`numberInKilograms`	Значение массы в килограммах.
`unitp`	Выходной параметр. Это будет содержать `NSMassFormatterUnit` значение, соответствующее возвращенным модулям.

Возвращаемое значение

Локализованная строка, представляющая модуль.

Обсуждение

Этот метод выбирает корректный модуль на основе локали средства форматирования, величины значения, и forPersonMassUse свойство. Значение, когда-то преобразованное в надлежащий модуль, определяет, является ли строка модуля множественным числом или исключительный.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.


    
    unitStringFromValue (_: модуль:)
    - unitStringFromValue:unit:

Возвращает строку модуля на основе предоставленного значения и модуля.

Объявление

Swift

func unitStringFromValue(_ value: Double, unit unit: NSMassFormatterUnit) -> String

Objective C

- (NSString *)unitStringFromValue:(double)value unit:(NSMassFormatterUnit)unit

Параметры

`value`	Значение массы для предоставленного модуля.
`unit`	Модуль для использования в получающейся массовой строке.

Возвращаемое значение

Локализованная строка, представляющая данный модуль. Предоставленное значение определяет, является ли модуль множественным числом или исключительный.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.

unitStyle unitStyle Свойство

Стиль модуля используется этим средством форматирования.

Объявление

Swift

var unitStyle: NSFormattingUnitStyle

Objective C

@property NSFormattingUnitStyle unitStyle

Обсуждение

Это свойство значения по умолчанию к NSFormattingUnitStyleMedium. Для полного списка стилей модуля посмотрите Formatting Units.

Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.

Константы

NSMassFormatterUnit
Модули, поддерживаемые NSMassFormatter класс.

Объявление

Swift

enum NSMassFormatterUnit : Int { case Gram case Kilogram case Ounce case Pound case Stone }

Objective C

typedef enum : NSInteger { NSMassFormatterUnitGram = 11, NSMassFormatterUnitKilogram = 14, NSMassFormatterUnitOunce = (6 << 8) + 1, NSMassFormatterUnitPound = (6 << 8) + 2, NSMassFormatterUnitStone = (6 << 8) + 3, } NSMassFormatterUnit;

Константы
- Gram
  
  NSMassFormatterUnitGram
  
  Модуль грамма.
  
  Доступный в OS X v10.10 и позже.
- Kilogram
  
  NSMassFormatterUnitKilogram
  
  Модуль килограмма.
  
  Доступный в OS X v10.10 и позже.
- Ounce
  
  NSMassFormatterUnitOunce
  
  Модуль унции.
  
  Доступный в OS X v10.10 и позже.
- Pound
  
  NSMassFormatterUnitPound
  
  Модуль фунта.
  
  Доступный в OS X v10.10 и позже.
- Stone
  
  NSMassFormatterUnitStone
  
  Каменный модуль.
  
  Доступный в OS X v10.10 и позже.
Оператор импорта

Objective C

@import Foundation;

Swift

import Foundation

Доступность

Доступный в OS X v10.10 и позже.