Instance Property

localizedDescription

A localized description of progress tracked by the receiver.

Declaration

@property(copy) NSString *localizedDescription;

Discussion

If you don’t specify your own custom value for this property, NSProgress uses the value of the kind property to determine how to use the values of other properties, as well as values in the user info dictionary, to return an automatically-computed string. If it fails to do that, it returns an empty string.

The localizedDescription represents a general description of the work tracked by the receiver. Depending on the kind of progress, the completed and total unit counts, and other parameters, example localized descriptions include:

  • Copying 10 files…

  • 30% completed

  • Copying “TextEdit”…

By default, NSProgress is KVO-compliant for this property, sending notifications on the same thread that updates the property.

See Also

Reporting Progress

totalUnitCount

The total number of units of work tracked for the current progress.

completedUnitCount

The number of units of work for the current job that have already been completed.

localizedAdditionalDescription

A more specific localized description of progress tracked by the receiver.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software