Skip to content

NSAttributedString

NSAttributedString 表示带属性(字体、颜色、段落样式等)的只读富文本。你可能会在 UI 文本渲染、富文本评论/编辑等场景中遇到它。

纯文本内容。

string(): string

Return Value:

  • string: 纯文本字符串。

字符长度。

length(): number

Return Value:

  • number: 长度。

指定位置的属性字典与有效范围。

attributesAtIndexEffectiveRange(location: number, range: any): NSDictionary

Parameters:

NameTypeDescription
locationnumber索引。
rangeany输出参数,接收有效范围。

Return Value:

  • NSDictionary: 该位置的属性字典。

指定位置的某属性值与有效范围。

attributeAtIndexEffectiveRange(attrName: string, location: number, range: any): any

Parameters:

NameTypeDescription
attrNamestring属性名。
locationnumber索引。
rangeany输出参数,接收有效范围。

Return Value:

  • any: 该位置的该属性值。

attributesAtIndexLongestEffectiveRangeInRange

Section titled “attributesAtIndexLongestEffectiveRangeInRange”

指定位置的属性与最长有效范围(在限定范围内)。

attributesAtIndexLongestEffectiveRangeInRange(location: number, range: any, rangeLimit: any): NSDictionary

Parameters:

NameTypeDescription
locationnumber索引。
rangeany输出参数,接收有效范围。
rangeLimitany限定范围。

Return Value:

  • NSDictionary: 属性字典。

attributeAtIndexLongestEffectiveRangeInRange

Section titled “attributeAtIndexLongestEffectiveRangeInRange”

指定位置的某属性与最长有效范围(在限定范围内)。

attributeAtIndexLongestEffectiveRangeInRange(attrName: string, location: number, range: any, rangeLimit: any): any

Parameters:

NameTypeDescription
attrNamestring属性名。
locationnumber索引。
rangeany输出参数,接收有效范围。
rangeLimitany限定范围。

Return Value:

  • any: 属性值。

取子富文本。

attributedSubstringFromRange(range: any): NSAttributedString

Parameters:

NameTypeDescription
rangeany范围(如 { location, length })。

Return Value:

  • NSAttributedString: 子富文本。

是否与另一富文本相等。

isEqualToAttributedString(other: NSAttributedString): boolean

Parameters:

NameTypeDescription
otherNSAttributedString另一富文本。

Return Value:

  • boolean: 是否相等。

enumerateAttributesInRangeOptionsUsingBlock

Section titled “enumerateAttributesInRangeOptionsUsingBlock”

在范围内枚举属性。

enumerateAttributesInRangeOptionsUsingBlock(enumerationRange: any, opts: number, block: (attrs: NSDictionary, range: any, stop: any) => void): void

Parameters:

NameTypeDescription
enumerationRangeany枚举范围。
optsnumber枚举选项。
block(attrs, range, stop) => void每段调用的回调。

Return Value:

  • 无。

enumerateAttributeInRangeOptionsUsingBlock

Section titled “enumerateAttributeInRangeOptionsUsingBlock”

在范围内枚举某属性。

enumerateAttributeInRangeOptionsUsingBlock(attrName: string, enumerationRange: any, opts: number, block: (value: any, range: any, stop: any) => void): void

Parameters:

NameTypeDescription
attrNamestring属性名。
enumerationRangeany枚举范围。
optsnumber枚举选项。
block(value, range, stop) => void每段调用的回调。

Return Value:

  • 无。

绘制尺寸(若在运行环境中可用)。

size(): any

Return Value:

  • any: 尺寸(如 { width, height })。

在点绘制(若在运行环境中可用)。

drawAtPoint(point: any): void

Parameters:

NameTypeDescription
pointany绘制点(如 { x, y })。

Return Value:

  • 无。

在矩形内绘制(若在运行环境中可用)。

drawInRect(rect: any): void

Parameters:

NameTypeDescription
rectany绘制矩形。

Return Value:

  • 无。

在矩形内按选项与上下文绘制(若在运行环境中可用)。

drawWithRectOptionsContext(rect: any, options: number, context: any): void

Parameters:

NameTypeDescription
rectany绘制矩形。
optionsnumber绘制选项。
contextany图形上下文。

Return Value:

  • 无。

在给定尺寸与选项下计算边界矩形(若在运行环境中可用)。

boundingRectWithSizeOptionsContext(size: any, options: number, context: any): any

Parameters:

NameTypeDescription
sizeany约束尺寸。
optionsnumber计算选项。
contextany图形上下文。

Return Value:

  • any: 边界矩形。

在矩形内按选项、属性与上下文绘制(若在运行环境中可用)。

drawWithRectOptionsAttributesContext(rect: any, options: number, attributes: NSDictionary, context: any): void

Parameters:

NameTypeDescription
rectany绘制矩形。
optionsnumber绘制选项。
attributesNSDictionary默认属性。
contextany图形上下文。

Return Value:

  • 无。

boundingRectWithSizeOptionsAttributesContext

Section titled “boundingRectWithSizeOptionsAttributesContext”

在给定尺寸、选项与属性下计算边界矩形(若在运行环境中可用)。

boundingRectWithSizeOptionsAttributesContext(size: any, options: number, attributes: NSDictionary, context: any): any

Parameters:

NameTypeDescription
sizeany约束尺寸。
optionsnumber计算选项。
attributesNSDictionary默认属性。
contextany图形上下文。

Return Value:

  • any: 边界矩形。

导出为数据(若在运行环境中可用)。

dataFromRangeDocumentAttributesError(range: any, dict: NSDictionary, error: any): NSData

Parameters:

NameTypeDescription
rangeany范围。
dictNSDictionary文档属性。
errorany输出参数,接收错误。

Return Value:

  • NSData: 导出数据。

fileWrapperFromRangeDocumentAttributesError

Section titled “fileWrapperFromRangeDocumentAttributesError”

导出为文件包装器(若在运行环境中可用)。

fileWrapperFromRangeDocumentAttributesError(range: any, dict: NSDictionary, error: any): any

Parameters:

NameTypeDescription
rangeany范围。
dictNSDictionary文档属性。
errorany输出参数,接收错误。

Return Value:

  • any: 文件包装器。

从附件创建富文本(部分环境可用)。

static attributedStringWithAttachment(attachment: any): NSAttributedString

Parameters:

NameTypeDescription
attachmentany附件对象。

Return Value:

  • NSAttributedString: 新富文本实例。
头文件 API 清单

正在加载…

协议:,来源: