Instance Method インスタンスメソッド

attribute(_:at:effectiveRange:)

Returns the value for an attribute with the specified name of the character at the specified index and, by reference, the range where the attribute applies. この指定されたインデックスでの文字のこの指定された名前をもつ属性に対する値そして、参照によって、その属性が適用されるところの範囲を返します。

Declaration 宣言

func attribute(_ attrName: NSAttributedString.Key, 
            at location: Int, 
effectiveRange range: NSRangePointer?) -> Any?

Parameters パラメータ

attrName

The name of an attribute. 属性の名前。

location

The index for which to return attributes. This value must not exceed the bounds of the receiver. それに対して属性を返すことになるインデックス。この値は、レシーバの境界を越えてはなりません。

range

If non-NULL: 非NULLならば：

If the named attribute exists at index, upon return aRange contains a range over which the named attribute’s value applies. 名前付属性がindexで存在するならば、戻りにおいてaRangeは、それに対して名前付属性の持つ値が適用される範囲を含みます。
If the named attribute does not exist at index, upon return aRange contains the range over which the attribute does not exist. 名前付属性がindexで存在しないならば、戻りにおいてaRangeは、それに対して属性が存在しない範囲を含みます。

The range isn’t necessarily the maximum range covered by attributeName, and its extent is implementation-dependent. If you need the maximum range, use attribute(_:at:longestEffectiveRange:in:). If you don't need this value, pass NULL. 範囲は、必ずしもattributeNameによって扱われる最大限の範囲ではなく、その限度は実装依存です。あなたが最大限の範囲を必要とするならば、attribute(_:at:longestEffectiveRange:in:)を使ってください。あなたがこの値を必要としないならば、NULLを渡してください。

Return Value 戻り値

The value for the attribute named attrName of the character at location, or nil if there is no such attribute. attrNameの名前を持つ属性の、locationでの文字の値、またはそのような属性がないならばnil。

Discussion 議論

For a list of possible attributes, see NSAttributedString.Key. 可能な属性の一覧として、NSAttributedString.Keyを見てください。