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

attribute(_:at:longestEffectiveRange:in:)

Returns the value for the 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, 
longestEffectiveRange range: NSRangePointer?, 
            in rangeLimit: NSRange) -> Any?

Parameters パラメータ

attributeName

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

index

The index at which to test for attributeName. それでattributeNameに対してテストすることになるインデックス。

aRange

If non-NULL: 非NULLならば：

  • If the named attribute exists at index, upon return aRange contains the full range over which the value of the named attribute is the same as that at index, clipped to rangeLimit. 名前付属性がindexで存在するならば、戻りにおいてaRangeは、それに対して名前付属性の値がindexでのそれと同じである完全な範囲を含みます、rangeLimitへと短縮されます。

  • If the named attribute does not exist at index, upon return aRange contains the full range over which the attribute does not exist, clipped to rangeLimit. 名前付属性がindexで存在しないならば、戻りにおいてaRangeは、それに対してこの属性が存在しない完全な範囲を含みます、rangeLimitへと短縮されます。

If you don't need this value, pass NULL. あなたがこの値を必要としないならば、NULLを渡してください。

rangeLimit

The range over which to search for continuous presence of attributeName. This value must not exceed the bounds of the receiver. それに対しattributeNameの連続した存在を検索することになる範囲。この値は、レシーバの境界を越えてはなりません。

Return Value 戻り値

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

Discussion 議論

Raises an rangeException if index or any part of rangeLimit lies beyond the end of the receiver’s characters. rangeExceptionを引き起こします、もしindexまたはrangeLimitの何らかの部分がレシーバの持つ文字の終わりを越えているならば。

If you don’t need the longest effective range, it’s far more efficient to use the attribute(_:at:effectiveRange:) method to retrieve the attribute value. あなたが最長有効範囲を必要としなしならば、attribute(_:at:effectiveRange:)メソッドを使って属性値を回収する方が、はるかに効率的です。

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

See Also 参照

Retrieving Attribute Information 属性情報を回収する

func attributes(at: Int, effectiveRange: NSRangePointer?) -> [NSAttributedString.Key : Any]
Returns the attributes for the character at the specified index. この指定されたインデックスでの文字に対する属性を返します。
func attributes(at: Int, longestEffectiveRange: NSRangePointer?, in: NSRange) -> [NSAttributedString.Key : Any]
Returns the attributes for the character at the specified index and, by reference, the range where the attributes apply. この指定されたインデックスでの文字に対する属性そして、参照によって、その属性が適用されるところの範囲を返します。
func attribute(NSAttributedString.Key, at: Int, effectiveRange: NSRangePointer?) -> Any?
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. この指定されたインデックスでの文字のこの指定された名前をもつ属性に対する値そして、参照によって、その属性が適用されるところの範囲を返します。