NSAttributedString是iOS富文本處理的基石,它透過屬性字典為文本的各個片段附加字體、顏色、樣式等信息。下面結合金山高工harvic整理的頭文件註釋,逐一梳理其常用屬性與相關枚舉。
//
// NSAttributedString.h
// UIKit
//
// Copyright (c) 2011-2015 Apple Inc. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <UIKit/UIKitDefines.h>
/************************ Attributes ************************/
/* 預定義的 text 字符屬性,如果這個 key 沒有在設置的 Dictionary 中,將會使用下面介紹的默認值 */
// 字體
UIKIT_EXTERN NSString *const NSFontAttributeName NS_AVAILABLE_IOS(6_0);
// UIFont, 默認 Helvetica(Neue) 12
// 段落樣式
UIKIT_EXTERN NSString *const NSParagraphStyleAttributeName NS_AVAILABLE_IOS(6_0);
// NSParagraphStyle, 默認 defaultParagraphStyle
// 文字顏色
UIKIT_EXTERN NSString *const NSForegroundColorAttributeName NS_AVAILABLE_IOS(6_0);
// UIColor, 默認 blackColor
// 文字背景顏色
UIKIT_EXTERN NSString *const NSBackgroundColorAttributeName NS_AVAILABLE_IOS(6_0);
// UIColor, 默認 nil:無背景
// 連體屬性,取值為 NSNumber(整數),0 表示無連體字符,1 表示使用默認連體字符
UIKIT_EXTERN NSString *const NSLigatureAttributeName NS_AVAILABLE_IOS(6_0);
// NSNumber containing integer, default 1: default ligatures, 0: no ligatures
// 字符間距
UIKIT_EXTERN NSString *const NSKernAttributeName NS_AVAILABLE_IOS(6_0);
// NSNumber containing floating point value, in points; 0 means kerning is disabled.
// 刪除線
UIKIT_EXTERN NSString *const NSStrikethroughStyleAttributeName NS_AVAILABLE_IOS(6_0);
// NSNumber containing integer, default 0: no strikethrough
// 下劃線
UIKIT_EXTERN NSString *const NSUnderlineStyleAttributeName NS_AVAILABLE_IOS(6_0);
// NSNumber containing integer, default 0: no underline
// 填充部分顏色,同前景色
UIKIT_EXTERN NSString *const NSStrokeColorAttributeName NS_AVAILABLE_IOS(6_0);
// UIColor, default nil: same as foreground color
// 筆畫寬度
UIKIT_EXTERN NSString *const NSStrokeWidthAttributeName NS_AVAILABLE_IOS(6_0);
// NSNumber containing floating point value, in percent of font point size,
// default 0: no stroke; positive for stroke alone, negative for stroke and fill
// 陰影屬性
UIKIT_EXTERN NSString *const NSShadowAttributeName NS_AVAILABLE_IOS(6_0);
// NSShadow, default nil: no shadow
// 文本特殊效果
UIKIT_EXTERN NSString *const NSTextEffectAttributeName NS_AVAILABLE_IOS(7_0);
// NSString, default nil: no text effect
// 文本附件,取值為 NSTextAttachment 對象,常用於文字圖片混排
UIKIT_EXTERN NSString *const NSAttachmentAttributeName NS_AVAILABLE_IOS(7_0);
// NSTextAttachment, default nil
// 鏈接屬性,點擊後呼叫浏覽器打開指定 URL 地址
UIKIT_EXTERN NSString *const NSLinkAttributeName NS_AVAILABLE_IOS(7_0);
// NSURL (preferred) or NSString
// 基線偏移值,取值為 NSNumber(float),正值上偏,負值下偏
UIKIT_EXTERN NSString *const NSBaselineOffsetAttributeName NS_AVAILABLE_IOS(7_0);
// NSNumber containing floating point value, in points; offset from baseline, default 0
// 下劃線顏色,取值為 UIColor 對象,默認同前景色
UIKIT_EXTERN NSString *const NSUnderlineColorAttributeName NS_AVAILABLE_IOS(7_0);
// UIColor, default nil: same as foreground color
// 刪除線顏色,取值為 UIColor 對象,默認同前景色
UIKIT_EXTERN NSString *const NSStrikethroughColorAttributeName NS_AVAILABLE_IOS(7_0);
// UIColor, default nil: same as foreground color
// 字形傾斜度,取值為 NSNumber(float),正值右傾,負值左傾
UIKIT_EXTERN NSString *const NSObliquenessAttributeName NS_AVAILABLE_IOS(7_0);
// NSNumber containing floating point value; skew to be applied to glyphs, default 0: no skew
// 文本橫向拉伸,取值為 NSNumber(float),正值橫向拉伸,負值橫向壓縮
UIKIT_EXTERN NSString *const NSExpansionAttributeName NS_AVAILABLE_IOS(7_0);
// NSNumber containing floating point value; log of expansion factor, default 0: no expansion
// 文字書寫方向,從左向右或從右向左書寫
UIKIT_EXTERN NSString *const NSWritingDirectionAttributeName NS_AVAILABLE_IOS(7_0);
// NSArray of NSNumbers representing the nested levels of writing direction overrides
// as defined by Unicode LRE, RLE, LRO, and RLO characters.
// 文字排版方向,取值為 NSNumber(整數),0 表示橫排,1 表示豎排
UIKIT_EXTERN NSString *const NSVerticalGlyphFormAttributeName NS_AVAILABLE_IOS(6_0);
// 0 means horizontal text. 1 indicates vertical text. Currently on iOS, it's always horizontal.
/* 下劃線、刪除線支持的樣式 */
typedef NS_ENUM(NSInteger, NSUnderlineStyle) {
NSUnderlineStyleNone = 0x00, // 不設置下劃線
NSUnderlineStyleSingle = 0x01, // 細單實線
NSUnderlineStyleThick NS_ENUM_AVAILABLE_IOS(7_0) = 0x02, // 粗單實線
NSUnderlineStyleDouble NS_ENUM_AVAILABLE_IOS(7_0) = 0x09, // 細雙實線
// 樣式掩碼
NSUnderlinePatternSolid NS_ENUM_AVAILABLE_IOS(7_0) = 0x0000, // 實線
NSUnderlinePatternDot NS_ENUM_AVAILABLE_IOS(7_0) = 0x0100, // 點線
NSUnderlinePatternDash NS_ENUM_AVAILABLE_IOS(7_0) = 0x0200, // 虛線
NSUnderlinePatternDashDot NS_ENUM_AVAILABLE_IOS(7_0) = 0x0300,
NSUnderlinePatternDashDotDot NS_ENUM_AVAILABLE_IOS(7_0) = 0x0400,
NSUnderlineByWord NS_ENUM_AVAILABLE_IOS(7_0) = 0x8000
} NS_ENUM_AVAILABLE_IOS(6_0);
/* NSWritingDirectionAttributeName 使用的書寫方向值 */
typedef NS_ENUM(NSInteger, NSTextWritingDirection) {
NSTextWritingDirectionEmbedding = (0 << 1),
NSTextWritingDirectionOverride = (1 << 1)
} NS_ENUM_AVAILABLE_IOS(7_0);
/* iOS 7.0 起 NSTextEffectAttributeName 支持的效果值 */
UIKIT_EXTERN NSString *const NSTextEffectLetterpressStyle NS_AVAILABLE_IOS(7_0);
頭文件後段還定義了屬性修正、文檔格式(RTF、HTML、純文本等)讀寫相關的接口,以及段落樣式、文檔尺寸、頁邊距等文檔級屬性。掌握這些屬性,就能靈活實現諸如混排圖文、局部變色、下劃線刪除線、可點擊鏈接等豐富的富文本效果。