NSMutableAttributedString

extension NSMutableAttributedString


                    
                    
                    trimCharacters(in:)

Modifies this instance of the string to remove characters from a given character set from the beginning and end of the string.

See http://panupan.com/2012/06/04/trim-leading-and-trailing-whitespaces-from-nsmutableattributedstring/

Declaration

Swift

public func trimCharacters(in set: CharacterSet)

Parameters


                                charSet

The character set with which to remove characters.


                    
                    
                    font(_:)

Applies a font to the entire string.

Declaration

Swift

@discardableResult
public func font(_ font: UIFont) -> Self

Parameters


                                font

The font.


                    
                    
                    font(name:size:)

Applies a font to the entire string.

Note: If the specified font name cannot be loaded, this method will fallback to the system font at the specified size.

Declaration

Swift

@discardableResult
public func font(name: String, size: CGFloat) -> Self

Parameters

`name`	The font name.
`size`	The font size.


                    
                    
                    alignment(_:)

Applies a text alignment to the entire string.

Declaration

Swift

@discardableResult
public func alignment(_ alignment: NSTextAlignment) -> Self

Parameters


                                alignment

The text alignment.


                    
                    
                    lineSpacing(_:)

Applies line spacing to the entire string.

Declaration

Swift

@discardableResult
public func lineSpacing(_ lineSpacing: CGFloat) -> Self

Parameters


                                lineSpacing

The line spacing amount.


                    
                    
                    paragraphSpacing(_:)

Applies paragraph spacing to the entire string.

Declaration

Swift

@discardableResult
public func paragraphSpacing(_ paragraphSpacing: CGFloat) -> Self

Parameters


                                paragraphSpacing

The paragraph spacing amount.


                    
                    
                    lineBreak(_:)

Applies a line break mode to the entire string.

Declaration

Swift

@discardableResult
public func lineBreak(_ mode: NSLineBreakMode) -> Self

Parameters


                                mode

The line break mode.


                    
                    
                    lineHeight(multiple:)

Applies a line height multiplier to the entire string.

Declaration

Swift

@discardableResult
public func lineHeight(multiple: CGFloat) -> Self

Parameters


                                multiple

The line height multiplier.


                    
                    
                    firstLineHeadIndent(_:)

Applies a first line head indent to the string.

Declaration

Swift

@discardableResult
public func firstLineHeadIndent(_ indent: CGFloat) -> Self

Parameters


                                indent

The first line head indent amount.


                    
                    
                    headIndent(_:)

Applies a head indent to the string.

Declaration

Swift

@discardableResult
public func headIndent(_ indent: CGFloat) -> Self

Parameters


                                indent

The head indent amount.


                    
                    
                    tailIndent(_:)

Applies a tail indent to the string.

Declaration

Swift

@discardableResult
public func tailIndent(_ indent: CGFloat) -> Self

Parameters


                                indent

The tail indent amount.


                    
                    
                    minimumLineHeight(_:)

Applies a minimum line height to the entire string.

Declaration

Swift

@discardableResult
public func minimumLineHeight(_ height: CGFloat) -> Self

Parameters


                                height

The minimum line height.


                    
                    
                    maximumLineHeight(_:)

Applies a maximum line height to the entire string.

Declaration

Swift

@discardableResult
public func maximumLineHeight(_ height: CGFloat) -> Self

Parameters


                                height

The maximum line height.


                    
                    
                    baseWritingDirection(_:)

Applies a base writing direction to the entire string.

Declaration

Swift

@discardableResult
public func baseWritingDirection(_ direction: NSWritingDirection) -> Self

Parameters


                                direction

The base writing direction.


                    
                    
                    paragraphSpacingBefore(_:)

Applies a paragraph spacing before amount to the string.

Declaration

Swift

@discardableResult
public func paragraphSpacingBefore(_ spacing: CGFloat) -> Self

Parameters


                                spacing

The distance between the paragraph’s top and the beginning of its text content.


                    
                    
                    color(_:alpha:)

Applies the given color over the entire string, as the foreground color.

Declaration

Swift

@discardableResult
@nonobjc
public func color(_ color: UIColor, alpha: CGFloat = 1) -> Self

Parameters


                                color

The color to apply.


                    
                    
                    color(red:green:blue:alpha:)

Applies the given color over the entire string, as the foreground color.

Declaration

Swift

@discardableResult
public func color(red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat = 1) -> Self

Parameters


                                color

The color to apply.


                    
                    
                    color(white:alpha:)

Applies the given color over the entire string, as the foreground color.

Declaration

Swift

@discardableResult
public func color(white: CGFloat, alpha: CGFloat = 1) -> Self

Parameters


                                color

The color to apply.


                    
                    
                    color(_:alpha:)

Applies the given color over the entire string, as the foreground color.

Declaration

Swift

@discardableResult
@nonobjc
public func color(_ hex: UInt32, alpha: CGFloat = 1) -> Self

Parameters


                                color

The color to apply.


                    
                    
                    underline(style:color:)

Applies a single underline under the entire string.

Declaration

Swift

@discardableResult
public func underline(style: NSUnderlineStyle = .single, color: UIColor? = nil) -> Self

Parameters


                                style

The NSUnderlineStyle to apply. Defaults to .styleSingle.


                    
                    
                    kern(_:)

Applies a kern (spacing) value to the entire string.

Declaration

Swift

@discardableResult
public func kern(_ value: CGFloat) -> Self

Parameters


                                value

The space between each character in the string.


                    
                    
                    strikethrough(style:color:)

Applies a strikethrough to the entire string.

Declaration

Swift

@discardableResult
public func strikethrough(style: NSUnderlineStyle = .single, color: UIColor? = nil) -> Self

Parameters

`style`	The `NSUnderlineStyle` to apply. Defaults to `.styleSingle`.
`color`	The underline color. Defaults to the color of the text.


                    
                    
                    stroke(color:width:)

Applies a stroke to the entire string.

Declaration

Swift

@discardableResult
public func stroke(color: UIColor, width: CGFloat) -> Self

Parameters

`color`	The stroke color.
`width`	The stroke width.


                    
                    
                    shadow(color:radius:offset:)

Applies a shadow to the entire string.

Declaration

Swift

@discardableResult
public func shadow(color: UIColor, radius: CGFloat, offset: CGSize) -> Self

Parameters

`color`	The shadow color.
`radius`	The shadow blur radius.
`offset`	The shadow offset.


                    
                    
                    backgroundColor(_:alpha:)

Applies a background color to the entire string.

Declaration

Swift

@discardableResult
@nonobjc
public func backgroundColor(_ color: UIColor, alpha: CGFloat = 1) -> Self

Parameters


                                color

The color to apply.


                    
                    
                    backgroundColor(red:green:blue:alpha:)

Applies a background color to the entire string.

Declaration

Swift

@discardableResult
public func backgroundColor(red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat = 1) -> Self

Parameters

`red`	The red color component.
`green`	The green color component.
`blue`	The blue color component.
`alpha`	The alpha component.


                    
                    
                    backgroundColor(white:alpha:)

Applies a background color to the entire string.

Declaration

Swift

@discardableResult
public func backgroundColor(white: CGFloat, alpha: CGFloat = 1) -> Self

Parameters

`white`	The white color component.
`alpha`	The alpha component.


                    
                    
                    backgroundColor(_:alpha:)

Applies a background color to the entire string.

Declaration

Swift

@discardableResult
@nonobjc
public func backgroundColor(_ hex: UInt32, alpha: CGFloat = 1) -> Self

Parameters

`hex`	The hex color value.
`alpha`	The alpha component.


                    
                    
                    baselineOffset(_:)

Applies a baseline offset to the entire string.

Declaration

Swift

@discardableResult
public func baselineOffset(_ offset: Float) -> Self

Parameters


                                offset

The offset value.