Instance Method

draw(with:options:attributes:)

Draws the receiver with the specified options and other display characteristics of the given attributes, within the specified rectangle in the current graphics context.

Declaration

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

Parameters

rect

The rectangle in which to draw the string.

options

String drawing options.

attributes

A dictionary of text attributes to be applied to 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.

Discussion

This method works in single-line, baseline rendering configuration by default. That is, the rect argument's origin field specifies the rendering origin, and that point is interpreted as the baseline origin by default. If the string drawing option NSStringDrawingUsesLineFragmentOrigin is specified, origin is interpreted as the upper left corner of the line fragment rectangle, and the method behaves in multiline configuration.

The size field specifies the text container size. The width part of the size field specifies the maximum line fragment width if larger than 0.0. The height defines the maximum size that can be occupied with text if larger than 0.0 and NSStringDrawingUsesLineFragmentOrigin is specified. If NSStringDrawingUsesLineFragmentOrigin is not specified, height is ignored and considered to be single-line rendering (NSLineBreakByWordWrapping and NSLineBreakByCharWrapping are treated as NSLineBreakByClipping).

You should only invoke this method when there is a current graphics context.

See Also

Deprecated

class func string(withCString: UnsafePointer<Int8>) -> Any?

Creates a new string using a given C-string.

Deprecated
init?(cString: UnsafePointer<Int8>)

Initializes the receiver, a newly allocated NSString object, by converting the data in a given C-string from the default C-string encoding into the Unicode character encoding.

Deprecated
class func string(withCString: UnsafePointer<Int8>, length: Int) -> Any?

Returns a string containing the characters in a given C-string.

Deprecated
init?(cString: UnsafePointer<Int8>, length: Int)

Initializes the receiver, a newly allocated NSString object, by converting the data in a given C-string from the default C-string encoding into the Unicode character encoding.

Deprecated
init?(cStringNoCopy: UnsafeMutablePointer<Int8>, length: Int, freeWhenDone: Bool)

Initializes the receiver, a newly allocated NSString object, by converting the data in a given C-string from the default C-string encoding into the Unicode character encoding.

Deprecated
class func string(withContentsOfFile: String) -> Any?

Returns a string created by reading data from the file named by a given path.

Deprecated
init?(contentsOfFile: String)

Initializes the receiver, a newly allocated NSString object, by reading data from the file named by path.

Deprecated
class func string(withContentsOf: URL) -> Any?

Returns a string created by reading data from the file named by a given URL.

Deprecated
init?(contentsOf: URL)

Initializes the receiver, a newly allocated NSString object, by reading data from the location named by a given URL.

Deprecated
func write(toFile: String, atomically: Bool) -> Bool

Writes the contents of the receiver to the file specified by a given path.

Deprecated
func write(to: URL, atomically: Bool) -> Bool

Writes the contents of the receiver to the location specified by a given URL.

Deprecated
func getCharacters(UnsafeMutablePointer<unichar>)

Copies all characters from the receiver into a given buffer.

Deprecated
func cString() -> UnsafePointer<Int8>?

Returns a representation of the receiver as a C string in the default C-string encoding.

Deprecated
func lossyCString() -> UnsafePointer<Int8>?

Returns a representation of the receiver as a C string in the default C-string encoding, possibly losing information in converting to that encoding.

Deprecated
func cStringLength() -> Int

Returns the length in char-sized units of the receiver’s C-string representation in the default C-string encoding.

Deprecated
func getCString(UnsafeMutablePointer<Int8>)

Invokes getCString(_:maxLength:range:remaining:) with NSMaximumStringLength as the maximum length, the receiver’s entire extent as the range, and NULL for the remaining range.

Deprecated
func getCString(UnsafeMutablePointer<Int8>, maxLength: Int)

Invokes getCString(_:maxLength:range:remaining:) with maxLength as the maximum length in char-sized units, the receiver’s entire extent as the range, and NULL for the remaining range.

Deprecated
func getCString(UnsafeMutablePointer<Int8>, maxLength: Int, range: NSRange, remaining: NSRangePointer?)

Converts the receiver’s content to the default C-string encoding and stores them in a given buffer.

Deprecated
func addingPercentEscapes(using: UInt) -> String?

Returns a representation of the receiver using a given encoding to determine the percent escapes necessary to convert the receiver into a legal URL string.

Deprecated
func replacingPercentEscapes(using: UInt) -> String?

Returns a new string made by replacing in the receiver all percent escapes with the matching characters as determined by a given encoding.

Deprecated
func boundingRect(with: NSSize, options: NSString.DrawingOptions, attributes: [NSAttributedString.Key : Any]?) -> NSRect

Calculates and returns the bounding rect for the receiver drawn using the given options and display characteristics, within the specified rectangle in the current graphics context.

Deprecated