Instance Method

attributedStringForObjectValue:withDefaultAttributes:

The default implementation returns nil to indicate that the formatter object does not provide an attributed string.

Declaration

- (NSAttributedString *)attributedStringForObjectValue:(id)obj withDefaultAttributes:(NSDictionary<NSAttributedStringKey, id> *)attrs;

Parameters

anObject

The object for which a textual representation is returned.

attributes

The default attributes to use for the returned attributed string.

Return Value

An attributed string that represents anObject.

Discussion

When implementing a subclass, return an NSAttributedString object if the string for display should have some attributes. For instance, you might want negative values in a financial application to appear in red text. Invoke your implementation of stringForObjectValue: to get the non-attributed string, then create an NSAttributedString object with it (see initWithString:). Use the attributes default dictionary to reset the attributes of the string when a change in value warrants it (for example, a negative value becomes positive) For information on creating attributed strings, see Attributed String Programming Guide.

See Also

Getting Textual Representations of Object Values

- stringForObjectValue:

The default implementation of this method raises an exception.

- editingStringForObjectValue:

The default implementation of this method invokes stringForObjectValue:.