Class

NumberFormatter

A formatter that converts between numeric values and their textual representations. 数値とそれらのテキスト表現の間で変換するフォーマッタ。

Declaration 宣言

class NumberFormatter : Formatter

Overview 概要

Instances of NumberFormatter format the textual representation of cells that contain NSNumber objects and convert textual representations of numeric values into NSNumber objects. The representation encompasses integers, floats, and doubles; floats and doubles can be formatted to a specified decimal position. NumberFormatter objects can also impose ranges on the numeric values cells can accept. NumberFormatterのインスタンスは、NSNumberオブジェクトを含んでいるセルのテキスト表現の書式を整えます、そして数値のテキスト表現をNSNumberオブジェクトへと変換します。表現は、integer、float、そしてdoubleを網羅します；floatとdoubleは、指定された小数部の桁に書式設定されることができます。NumberFormatterオブジェクトはまた、セルが受け入れ可能な数値に範囲を課すことができます。

Significant Digits and Fraction Digits 有効桁と小数桁

The NumberFormatter class provides flexible options for displaying non-zero fractional parts of numbers. NumberFormatterクラスは、数値の非ゼロ小数部を表示するのに柔軟な選択肢を提供します。

If you set the usesSignificantDigits property to true, you can configure NumberFormatter to display significant digits using the minimumSignificantDigits and maximumSignificantDigits properties. If usesSignificantDigits is false, these properties are ignored. See Configuring Significant Digits. あなたがusesSignificantDigitsプロパティをtrueに設定するならば、あなたはNumberFormatterを構成設定して、minimumSignificantDigitsおよびmaximumSignificantDigitsプロパティを使って有効桁数を表示するようにできます。usesSignificantDigitsがfalseならば、これらのプロパティは無視されます。有効桁数を構成設定するを見てください。

Otherwise, you can configure the minimum and maximum number of integer and fraction digits, or the numbers before and after the decimal separator, respectively, using the minimumIntegerDigits, maximumIntegerDigits, minimumFractionDigits, and maximumFractionDigits properties. See Configuring Integer and Fraction Digits. そうでなければ、あなたは整数と小数桁の最小および最大数を、または小数分離子の前と後の数を、それぞれ、minimumIntegerDigits、maximumIntegerDigits、minimumFractionDigits、そしてmaximumFractionDigitsプロパティを使って構成設定できます。整数および小数桁を構成設定するを見てください。

Thread Safety スレッド安全

On iOS 7 and later NumberFormatter is thread-safe. iOS 7以降ではNumberFormatterはスレッド安全です。

In macOS 10.9 and later NumberFormatter is thread-safe so long as you are using the modern behavior in a 64-bit app. macOS 10.9以降ではNumberFormatterはスレッド安全です、あなたがモダンな挙動を64-bitアプリにおいて使っている限りは。

On earlier versions of the operating system, or when using the legacy formatter behavior or running in 32-bit in macOS, NumberFormatter is not thread-safe, and you therefore must not mutate a number formatter simultaneously from multiple threads. オペレーティングシステムの以前のバージョンでは、またはレガシーフォーマッタ挙動を使うまたは32-bitをmacOSで実行する場合、NumberFormatterはスレッド安全ではありません、そしてあなたはそのゆえに複数のスレッドから同時に数値フォーマッタを変更してはいけません。

Topics 話題

Configuring Formatter Behavior and Style フォーマッタ挙動と形式を構成設定する

var formatterBehavior: NumberFormatter.Behavior

The formatter behavior of the receiver. レシーバのフォーマッタ挙動。

class func setDefaultFormatterBehavior(NumberFormatter.Behavior)

Sets the default formatter behavior for new instances of NSNumberFormatter . 省略時のフォーマッタ挙動をNSNumberFormatterの新しいインスタンスに対して設定します。

class func defaultFormatterBehavior() -> NumberFormatter.Behavior

Returns an NSNumberFormatterBehavior constant that indicates default formatter behavior for new instances of NSNumberFormatter. NSNumberFormatterBehavior定数を返します、それは省略時のフォーマッタ挙動をNSNumberFormatterの新しいインスタンスに対して指し示します。

var numberStyle: NumberFormatter.Style

The number style used by the receiver. レシーバによって使われる数値様式。

var generatesDecimalNumbers: Bool

Determines whether the receiver creates instances of NSDecimalNumber when it converts strings to number objects. レシーバがNSDecimalNumberのインスタンスを、それが文字列を数値オブジェクトへと変換する時に作成するかどうかを決定します。

Converting Between Numbers and Strings 数値と文字列の間で変換する

func getObjectValue(AutoreleasingUnsafeMutablePointer<AnyObject?>?, for: String, range: UnsafeMutablePointer<NSRange>?)

Returns by reference a cell-content object after creating it from a range of characters in a given string. あるセル内容オブジェクトを、それをある与えられた文字列の中のある範囲の文字から作成した後に、参照によって返します。

func number(from: String) -> NSNumber?

Returns an NSNumber object created by parsing a given string. 与えられた文字列を構文解析することによって作成されるNSNumberオブジェクトを返します。

func string(from: NSNumber) -> String?

Returns a string containing the formatted value of the provided number object. 提供された数値オブジェクトの書式設定された値を含んでいる文字列を返します。

class func localizedString(from: NSNumber, number: NumberFormatter.Style) -> String

Returns a localized number string with the specified style. 指定された形式でローカライズされた数値文字列を返します。

Managing Localization of Numbers 数値のローカライゼーションを管理する

var localizesFormat: Bool

Determines whether the dollar sign character ($), decimal separator character (.), and thousand separator character (,) are converted to appropriately localized characters as specified by the user’s localization preference. ドル記号の文字（$）、小数分離子の文字（.）、そして千位分離子の文字（,）が、適切にローカライズされた文字へとユーザのもつローカライゼーション環境設定によって指定されるように変換されるかどうかを決定します。

var locale: Locale!

The locale of the receiver. レシーバのロケール。

Configuring Rounding Behavior 丸め挙動を構成設定する

var roundingBehavior: NSDecimalNumberHandler

The rounding behavior used by the receiver. レシーバによって使われる丸め挙動。

class NSDecimalNumberHandler

A class that adopts the decimal number behaviors protocol. 10進数挙動プロトコルを採用するクラス。

var roundingIncrement: NSNumber!

The rounding increment used by the receiver. レシーバによって使われる丸め増分。

var roundingMode: NumberFormatter.RoundingMode

The rounding mode used by the receiver. レシーバによって使われる丸めモード。

Configuring Integer and Fraction Digits 整数および小数桁を構成設定する

var minimumIntegerDigits: Int

The minimum number of digits before the decimal separator. 小数分離子の前の最小限の桁数。

var maximumIntegerDigits: Int

The maximum number of digits before the decimal separator. 小数分離子の前の最大限の桁数。

var minimumFractionDigits: Int

The minimum number of digits after the decimal separator. 小数分離子の後の最小限の桁数。

var maximumFractionDigits: Int

The maximum number of digits after the decimal separator. 小数分離子の後の最大限の桁数。

Configuring Significant Digits 有効桁数を構成設定する

var usesSignificantDigits: Bool

A Boolean value indicating whether the formatter uses minimum and maximum significant digits when formatting numbers. フォーマッタが数値を書式設定している時に最小および最大有効桁数を使用するかどうかを指し示すブール値。

var minimumSignificantDigits: Int

The minimum number of significant digits for the number formatter. 数値フォーマッタに対する最小の有効桁数。

var maximumSignificantDigits: Int

The maximum number of significant digits for the number formatter. 数値フォーマッタに対する最大の有効桁数。

Configuring Numeric Formats 数値書式設定を構成設定する

var format: String

The receiver’s format. レシーバのもつ書式設定。

var formattingContext: Formatter.Context

The capitalization formatting context used when formatting a number. ある数値を書式設定している時に使われるキャピタライゼーション書式設定文脈。

var formatWidth: Int

The format width used by the receiver. レシーバによって使われる書式設定幅。

var negativeFormat: String!

The format the receiver uses to display negative values. レシーバが使って負の値を表示する書式設定。

var positiveFormat: String!

The format the receiver uses to display positive values. レシーバが使って正の値を表示する書式設定。

var multiplier: NSNumber?

The multiplier of the receiver. レシーバの乗数。

Configuring Numeric Symbols 数値表象を構成設定する

var percentSymbol: String!

The string used to represent a percent symbol. パーセント表象を表すのに使われる文字列。

var perMillSymbol: String!

The string used to represent a per-mill (per-thousand) symbol. パーミル（千分率）表象を表すのに使われる文字列。

var minusSign: String!

The string used to represent a minus sign. マイナス記号を表すのに使われる文字列。

var plusSign: String!

The string used to represent a plus sign. プラス記号を表すのに使われる文字列。

var exponentSymbol: String!

The string used to represent an exponent symbol. 指数表象を表すのに使われる文字列。

var zeroSymbol: String?

The string used to represent a zero value. ゼロ値を表すのに使われる文字列。

var nilSymbol: String

The string used to represent a nil value. nil値を表すのに使われる文字列。

var notANumberSymbol: String!

The string used to represent a NaN (“not a number”) value. NaN（“not a number”、非数）値を表すのに使われる文字列。

var negativeInfinitySymbol: String

The string used to represent a negative infinity symbol. 負の無限大表象を表すのに使われる文字列。

var positiveInfinitySymbol: String

The string used to represent a positive infinity symbol. 正の無限大表象を表すのに使われる文字列。

Configuring the Format of Currency 通貨の書式設定を構成設定する

var currencySymbol: String!

The string used by the receiver as a local currency symbol. レシーバによって現地通貨記号として使われる文字列。

var currencyCode: String!

The receiver’s currency code. レシーバのもつ通貨コード。

var internationalCurrencySymbol: String!

The international currency symbol used by the receiver. レシーバによって使われる国際通貨記号。

var currencyGroupingSeparator: String!

The currency grouping separator for the receiver. レシーバに対する通貨グループ分離子。

Configuring Numeric Prefixes and Suffixes 数値接頭辞と接尾辞を構成設定する

var positivePrefix: String!

The string the receiver uses as the prefix for positive values. レシーバが正の値に対する接頭辞として使う文字列。

var positiveSuffix: String!

The string the receiver uses as the suffix for positive values. レシーバが正の値に対する接尾辞として使う文字列。

var negativePrefix: String!

The string the receiver uses as a prefix for negative values. レシーバが負の値に対する接頭辞として使う文字列。

var negativeSuffix: String!

The string the receiver uses as a suffix for negative values. レシーバが負の値に対する接尾辞として使う文字列。

Configuring the Display of Numeric Values 数値の表示を構成設定する

var textAttributesForNegativeValues: [String : Any]?

The text attributes to be used in displaying negative values. 負の値を表示するのに使われるテキスト属性。

var textAttributesForPositiveValues: [String : Any]?

The text attributes to be used in displaying positive values. 正の値を表示するのに使われるテキスト属性。

var attributedStringForZero: NSAttributedString

The attributed string that the receiver uses to display zero values. レシーバがゼロ値を表示するのに使う属性付き文字列。

var textAttributesForZero: [String : Any]?

The text attributes used to display a zero value. ゼロ値を表示するのに使われるテキスト属性。

var attributedStringForNil: NSAttributedString

The attributed string the receiver uses to display nil values. レシーバがnil値を表示するのに使う属性付き文字列。

var textAttributesForNil: [String : Any]?

The text attributes used to display the nil symbol. nil表象を表示するのに使われるテキスト属性。

var attributedStringForNotANumber: NSAttributedString

The attributed string the receiver uses to display “not a number” values. レシーバが “not a number 非数” 値を表示するのに使う属性付き文字列。

var textAttributesForNotANumber: [String : Any]?

The text attributes used to display the NaN (“not a number”) string. NaN（“not a number”）文字列を表示するのに使われるテキスト属性。

var textAttributesForPositiveInfinity: [String : Any]?

The text attributes used to display the positive infinity symbol. 正の無限大表象を表示するために使われるテキスト属性。

var textAttributesForNegativeInfinity: [String : Any]?

The text attributes used to display the negative infinity symbol. 負の無限大表象を表示するために使われるテキスト属性。

Configuring Separators and Grouping Size 分離子やグループサイズを構成設定する

var groupingSeparator: String!

The string used by the receiver for a grouping separator. グループ分離子に対してレシーバによって使われる文字列。

var usesGroupingSeparator: Bool

Determines whether the receiver displays the group separator. レシーバがグループ分離子を表示するかどうかを決定します。

var thousandSeparator: String!

The character the receiver uses as a thousand separator. レシーバが千位分離子として使う文字。

var hasThousandSeparators: Bool

Determines whether the receiver uses thousand separators. レシーバが千位分離子を使うかどうかを決定します。

var decimalSeparator: String!

The character the receiver uses as a decimal separator. レシーバが小数分離子として使う文字。

var alwaysShowsDecimalSeparator: Bool

Determines whether the receiver always shows the decimal separator, even for integer numbers. レシーバが常に小数分離子を表示するかどうかを決定します、整数に対してさえもです。

var currencyDecimalSeparator: String!

The string used by the receiver as a currency decimal separator. 通貨小数分離子としてレシーバによって使われる文字列。

var groupingSize: Int

The grouping size of the receiver. レシーバのグループサイズ。

var secondaryGroupingSize: Int

The secondary grouping size of the receiver. レシーバの副次グループサイズ。

Managing the Padding of Numbers 数字の詰めを管理する

var paddingCharacter: String!

The string that the receiver uses to pad numbers in the formatted string representation. 書式設定された文字列表現においてレシーバが数字を詰めるのに使う文字列。

var paddingPosition: NumberFormatter.PadPosition

The padding position used by the receiver. レシーバによって使われる詰め位置。

Managing Input and Output Attributes 入力と出力属性を管理する

var allowsFloats: Bool

Determines whether the receiver allows as input floating-point values (that is, values that include the period character [.]). レシーバが入力として浮動小数点値（すなわち、ピリオド文字 [.] を含む値）を許可するかどうかを決定します。

var minimum: NSNumber?

The lowest number allowed as input by the receiver. 入力としてレシーバによって許可される最低の数。

var maximum: NSNumber?

The highest number allowed as input by the receiver. 入力としてレシーバによって許可される最高の数。

Managing Leniency Behavior 寛容挙動を管理する

var isLenient: Bool

Determines whether the receiver will use heuristics to guess at the number which is intended by a string. レシーバがある文字列によって意図される数字を発見的手法を使って推測するかどうかを決定します。

Managing the Validation of Partial Numeric Strings 不完全な数値的文字列の検証を管理する

var isPartialStringValidationEnabled: Bool

Determines whether partial string validation is enabled for the receiver. 不完全文字列の検証がレシーバに対して可能にされるかどうかを決定します。

Constants 定数

enum NumberFormatter.Style

The predefined number format styles used by the numberStyle property. numberStyleプロパティによって使われるあらかじめ定義された数値書式設定形式。

enum NumberFormatter.Behavior

These constants specify the behavior of a number formatter. These constants are returned by the defaultFormatterBehavior() class method and the formatterBehavior property. これらの定数は、数値フォーマッタの挙動を指定します。これらの定数は、defaultFormatterBehavior()クラスメソッドとformatterBehaviorプロパティによって返されます。

enum NumberFormatter.PadPosition

These constants are used to specify how numbers should be padded. These constants are used by the paddingPosition property. これらの定数は、どうやって数値が詰められるべきか指定するのに使われます。これらの定数は、paddingPositionプロパティによって使われます。

enum NumberFormatter.RoundingMode

These constants are used to specify how numbers should be rounded. These constants are used by the roundingMode property. これらの定数は、どうやって数値が丸められるべきか指定するのに使われます。これらの定数は、roundingModeプロパティによって使われます。

Relationships 関係

Inherits From 継承元

Formatter