Instance Property


A block that converts a candidate object into an attributed string for display in the candidate list item.


@property(copy, nonnull) NSAttributedString * (^attributedStringForCandidate)(CandidateType candidate, NSInteger index);


This property is not required if the object type of your candidates is NSString, NSAttributedString, or NSTextCheckingResult. The default value of this property is nil.

If the attributed string you return does not specify NSFontAttributeName or NSForegroundColorAttributeName then the candidate is displayed with the standard appearance font and color.

See Also

Populating the Candidate List

- setCandidates:forSelectedRange:inString:

Sets an array of candidate objects to be displayed in the candidate list bar item.


The array of candidate objects previously set by setCandidates:forSelectedRange:inString:.


A Boolean value that specifies whether a candidate list item displays candidates from text input providers.