Foundation.NSProgress Members

The members of Foundation.NSProgress are listed below.

See Also: Inherited members from Foundation.NSObject

Public Constructors

Default constructor, initializes a new instance of this class.
Documentation for this section has not yet been entered.

Protected Constructors

Constructor to call on derived classes to skip initialization and merely allocate the object.
A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

Public Properties

Cancellablebool. Whether this is tracking work that can be cancelled.
[read-only]
Cancelledbool. Whether this is tracking work that was cancelled.
[read-only]
override
ClassHandleIntPtr. The handle for this class.
CompletedUnitCountlong. The number of work units for the current job that have already been completed.
[read-only]
static
CurrentProgressNSProgress. The NSProgress object, if any, associated with the calling thread due to a previous call to BecomeCurrent.
[read-only]
static
EstimatedTimeRemainingKeyNSString. Represents the value associated with the constant NSProgressEstimatedTimeRemainingKey
[read-only]
static
FileCompletedCountKeyNSString. Represents the value associated with the constant NSProgressFileCompletedCountKey
[read-only]
static
FileOperationKindCopyingNSString. Represents the value associated with the constant NSProgressFileOperationKindCopying
[read-only]
static
FileOperationKindDecompressingAfterDownloadingNSString. Represents the value associated with the constant NSProgressFileOperationKindDecompressingAfterDownloading
[read-only]
static
FileOperationKindDownloadingNSString. Represents the value associated with the constant NSProgressFileOperationKindDownloading
[read-only]
static
FileOperationKindKeyNSString. Represents the value associated with the constant NSProgressFileOperationKindKey
[read-only]
static
FileOperationKindReceivingNSString. Represents the value associated with the constant NSProgressFileOperationKindReceiving
[read-only]
static
FileTotalCountKeyNSString. Represents the value associated with the constant NSProgressFileTotalCountKey
[read-only]
static
FileURLKeyNSString. Represents the value associated with the constant NSProgressFileURLKey
[read-only]
FractionCompleteddouble. The fraction of the overall work completed by this object and any of its children. Read-only.
[read-only]
Indeterminatebool. Whether the tracked progress is indeterminate. Read-only.
KindNSString. One of the constants defined by FileOperationKind* or KindFile, indicating the type of progress being made.
[read-only]
static
KindFileNSString. Represents the value associated with the constant NSProgressKindFile
LocalizedAdditionalDescriptionstring. A description of the kind of progress being made, more specific than LocalizedAdditionalDescription.
LocalizedDescriptionstring. A localized description of the progress being tracked, more specific than Kind, but less specific than LocalizedAdditionalDescription.
Pausablebool. Documentation for this section has not yet been entered.
[read-only]
Pausedbool. Documentation for this section has not yet been entered.
[read-only]
static
ThroughputKeyNSString. Represents the value associated with the constant NSProgressThroughputKey
TotalUnitCountlong. Documentation for this section has not yet been entered.
[read-only]
UserInfoNSDictionary. Documentation for this section has not yet been entered.

Public Methods

BecomeCurrent(long)
Sets this as the current progress object on the calling thread and specifies the number of work units to be carried out by the next child progress object.
Cancel()
Cancels progress tracking.
static
FromTotalUnitCount(long) : NSProgress
Factory method that creates a new NSProgress, which is constructed as a child of the CurrentProgress, if non-null.
Pause()
Documentation for this section has not yet been entered.
ResignCurrent()
Documentation for this section has not yet been entered.
SetCancellationHandler(Action)
Documentation for this section has not yet been entered.
SetPauseHandler(Action)
Documentation for this section has not yet been entered.
SetUserInfo(NSObject, NSString)
Documentation for this section has not yet been entered.

Protected Methods

override
Dispose(bool)
Releases the resources used by the NSProgress object.