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

draw(with:options:attributes:context:)

Draws the attributed string in the specified bounding rectangle using the provided options. 属性付文字列をこの指定された境界矩形の内側にその提供されたオプションを使って描画します。

Declaration 宣言

iOS, iPadOS, Mac Catalyst, tvOS, watchOS

func draw(with rect: CGRect, 
  options: NSStringDrawingOptions = [], 
attributes: [NSAttributedString.Key : Any]? = nil, 
  context: NSStringDrawingContext?)

macOS

func draw(with rect: NSRect, 
  options: NSString.DrawingOptions = [], 
attributes: [NSAttributedString.Key : Any]? = nil, 
  context: NSStringDrawingContext?)

Parameters パラメータ

rect

The bounding rectangle in which to draw the string. それの中に文字列を描画することになる境界矩形。

options オプション

Additional drawing options to apply to the string during rendering. レンダリングの間に文字列に適用することになる追加の描画オプション。 For a list of possible values, see NSString.DrawingOptions.

attributes

The text attributes with which to draw the string. These are the same attributes that can be applied to an NSAttributedString object, but in the case of NSString objects, the attributes apply to the entire string, rather than ranges within the string. それを使って文字列を描画することになるテキスト属性。NSAttributedStringオブジェクトに適用されることができるのと同じ属性があります、しかしNSStringオブジェクトの場合には、属性は文字列全体に適用されます、文字列内の範囲ではなく。

context

A context object with information about how to adjust the font tracking and scaling information. On return, the specified object contains information about the actual values used to render the string. This parameter may be nil. どのようにフォントのトラッキングおよびスケーリング情報を調整するかについての情報を持つコンテキストオブジェクト。戻りにおいて、この指定されたオブジェクトは、文字列を描出するのに使われる実際の値についての情報を含みます。このパラメータはnilであるかもしれません。

Discussion 議論

This method draws as much of the string as it can inside the specified rectangle, wrapping the string text as needed to make it fit. If the string is too big to fit completely inside the rectangle, the method scales the font or adjusts the letter spacing to make the string fit within the given bounds. このメソッドは、多くの文字列をそれがその指定された矩形内部に可能なだけ描画して、文字列テキストを必要に応じてそれがぴったり収まるようにワードラップしています。文字列が矩形内に完全に収まるには大きすぎるならば、メソッドはフォントを縮尺するまたは文字の間隔を調整して、文字列をこの与えられた境界内に収まるようにします。

If newline characters are present in the string, those characters are honored and cause subsequent text to be placed on the next line underneath the starting point. To correctly draw and size multi-line text, pass usesLineFragmentOrigin in the options parameter. 改行文字が文字列において存在するならば、それら文字は尊重されます、そして続くテキストが、開始点の真下の次の行上に置かれるようにします。複数行テキストを正しく描画および大きさ指定するには、usesLineFragmentOriginをオプションパラメータにおいて渡してください。

Special Considerations 特別な注意事項

This method uses the baseline origin by default. このメソッドは、ベースライン原点を初期状態では使います。

If usesLineFragmentOrigin is not specified, the rectangle’s height will be ignored and the operation considered to be single-line rendering. usesLineFragmentOriginが指定されないならば、矩形の持つ高さは無視されます、そして演算は単一行描画であるとみなされます。

See Also 参照

Sizing and Drawing Strings 文字列の大きさ指定と描画