NSProgress Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Used with long-running processes to report progress to the end-user.
[Foundation.Register("NSProgress", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 9, ObjCRuntime.PlatformArchitecture.All, null)]
public class NSProgress : Foundation.NSObjecttype NSProgress = class
inherit NSObject- Inheritance
- Attributes
Constructors
| NSProgress() |
Default constructor, initializes a new instance of this class. |
| NSProgress(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| NSProgress(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
| NSProgress(NSProgress, NSDictionary) | |
Properties
| Cancellable |
Whether this is tracking work that can be cancelled. |
| Cancelled |
Whether this is tracking work that was cancelled. |
| Class | (Inherited from NSObject) |
| ClassHandle |
The handle for this class. |
| CompletedUnitCount |
The number of work units for the current job that have already been completed. |
| CurrentProgress |
The NSProgress object, if any, associated with the calling thread due to a previous call to BecomeCurrent. |
| DebugDescription |
A developer-meaningful description of this object. (Inherited from NSObject) |
| Description |
Description of the object, the Objective-C version of ToString. (Inherited from NSObject) |
| EstimatedTimeRemaining | |
| EstimatedTimeRemainingKey |
Represents the value associated with the constant NSProgressEstimatedTimeRemainingKey |
| FileAnimationImageKey | |
| FileAnimationImageOriginalRectKey | |
| FileCompletedCount | |
| FileCompletedCountKey |
Represents the value associated with the constant NSProgressFileCompletedCountKey |
| FileIconKey | |
| FileOperationKind | |
| FileOperationKindCopying |
Represents the value associated with the constant NSProgressFileOperationKindCopying |
| FileOperationKindDecompressingAfterDownloading |
Represents the value associated with the constant NSProgressFileOperationKindDecompressingAfterDownloading |
| FileOperationKindDownloading |
Represents the value associated with the constant NSProgressFileOperationKindDownloading |
| FileOperationKindKey |
Represents the value associated with the constant NSProgressFileOperationKindKey |
| FileOperationKindReceiving |
Represents the value associated with the constant NSProgressFileOperationKindReceiving |
| FileTotalCount | |
| FileTotalCountKey |
Represents the value associated with the constant NSProgressFileTotalCountKey |
| FileUrl | |
| FileURLKey |
Represents the value associated with the constant NSProgressFileURLKey |
| Finished | |
| FractionCompleted |
The fraction of the overall work completed by this object and any of its children. Read-only. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| Indeterminate |
Whether the tracked progress is indeterminate. Read-only. |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| Kind |
One of the constants defined by FileOperationKind* or KindFile, indicating the type of progress being made. |
| KindFile |
Represents the value associated with the constant NSProgressKindFile |
| LocalizedAdditionalDescription |
A description of the kind of progress being made, more specific than LocalizedAdditionalDescription. |
| LocalizedDescription |
A localized description of the progress being tracked, more specific than Kind, but less specific than LocalizedAdditionalDescription. |
| Old | |
| Pausable | |
| Paused | |
| RetainCount |
Returns the current Objective-C retain count for the object. (Inherited from NSObject) |
| Self | (Inherited from NSObject) |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| Throughput | |
| ThroughputKey |
Represents the value associated with the constant NSProgressThroughputKey |
| TotalUnitCount | |
| UserInfo | |
| Zone | (Inherited from NSObject) |
Methods
| AcknowledgeWithSuccess(Boolean) | |
| AddChild(NSProgress, Int64) | |
| AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) |
Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject) |
| AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) |
Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject) |
| AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AddSubscriberForFile(NSUrl, Action<NSProgress>) | |
| AwakeFromNib() |
Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject) |
| BecomeCurrent(Int64) |
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. |
| BeginInvokeOnMainThread(Action) | (Inherited from NSObject) |
| BeginInvokeOnMainThread(Selector, NSObject) |
Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSDictionary) | (Inherited from NSObject) |
| Bind(String, NSObject, String, NSDictionary) |
Obsolete.
(Inherited from NSObject)
|
| BindingInfo(String) |
Obsolete.
(Inherited from NSObject)
|
| BindingOptionDescriptions(String) |
Obsolete.
(Inherited from NSObject)
|
| BindingValueClass(String) |
Obsolete.
(Inherited from NSObject)
|
| Cancel() |
Cancels progress tracking. |
| CommitEditing() | (Inherited from NSObject) |
| CommitEditing(NSObject, Selector, IntPtr) | (Inherited from NSObject) |
| ConformsToProtocol(IntPtr) |
Invoked to determine if this object implements the specified protocol. (Inherited from NSObject) |
| Copy() |
Performs a copy of the underlying Objective-C object. (Inherited from NSObject) |
| DangerousAutorelease() | (Inherited from NSObject) |
| DangerousRelease() | (Inherited from NSObject) |
| DangerousRetain() | (Inherited from NSObject) |
| DidChange(NSKeyValueChange, NSIndexSet, NSString) |
Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject) |
| DidChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| DidChangeValue(String) |
Indicates that a change occurred on the specified key. (Inherited from NSObject) |
| Dispose() |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| Dispose(Boolean) |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| DoesNotRecognizeSelector(Selector) |
Indicates that this object does not recognize the specified selector. (Inherited from NSObject) |
| Equals(NSObject) | (Inherited from NSObject) |
| Equals(Object) | (Inherited from NSObject) |
| ExposedBindings() | (Inherited from NSObject) |
| FromTotalUnitCount(Int64) |
Factory method that creates a new NSProgress, which is constructed as a child of the CurrentProgress, if non-null. |
| FromTotalUnitCount(Int64, NSProgress, Int64) | |
| GetBindingInfo(NSString) | (Inherited from NSObject) |
| GetBindingOptionDescriptions(NSString) | (Inherited from NSObject) |
| GetBindingValueClass(NSString) | (Inherited from NSObject) |
| GetDictionaryOfValuesFromKeys(NSString[]) |
Retrieves the values of the specified keys. (Inherited from NSObject) |
| GetDiscreteProgress(Int64) | |
| GetHashCode() |
Generates a hash code for the current instance. (Inherited from NSObject) |
| GetMethodForSelector(Selector) | (Inherited from NSObject) |
| GetNativeField(String) |
Obsolete.
(Inherited from NSObject)
|
| GetNativeHash() | (Inherited from NSObject) |
| Init() | (Inherited from NSObject) |
| InitializeHandle(IntPtr) | (Inherited from NSObject) |
| InitializeHandle(IntPtr, String) | (Inherited from NSObject) |
| Invoke(Action, Double) | (Inherited from NSObject) |
| Invoke(Action, TimeSpan) | (Inherited from NSObject) |
| InvokeOnMainThread(Action) | (Inherited from NSObject) |
| InvokeOnMainThread(Selector, NSObject) |
Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject) |
| IsEqual(NSObject) | (Inherited from NSObject) |
| IsKindOfClass(Class) | (Inherited from NSObject) |
| IsMemberOfClass(Class) | (Inherited from NSObject) |
| MarkDirty() |
Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject) |
| MutableCopy() |
Creates a mutable copy of the specified NSObject. (Inherited from NSObject) |
| ObjectDidEndEditing(NSObject) | (Inherited from NSObject) |
| ObserveValue(NSString, NSObject, NSDictionary, IntPtr) |
Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject) |
| Pause() | |
| PerformAsCurrent(Int64, Action) | |
| PerformAsCurrentAsync(Int64) | |
| PerformSelector(Selector) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, Double) |
Invokes the selector on the current instance and if the |
| PerformSelector(Selector, NSObject, Double, NSString[]) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) | (Inherited from NSObject) |
| PrepareForInterfaceBuilder() | (Inherited from NSObject) |
| Publish() | |
| RemoveObserver(NSObject, NSString) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject) |
| RemoveObserver(NSObject, NSString, IntPtr) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject) |
| RemoveObserver(NSObject, String) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject) |
| RemoveObserver(NSObject, String, IntPtr) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject) |
| RemoveSubscriber(NSObject) | |
| ResignCurrent() | |
| RespondsToSelector(Selector) |
Whether this object recognizes the specified selector. (Inherited from NSObject) |
| Resume() | |
| SetAcknowledgementHandler(Action<Boolean>, String) | |
| SetCancellationHandler(Action) | |
| SetNativeField(String, NSObject) |
Obsolete.
(Inherited from NSObject)
|
| SetNilValueForKey(NSString) |
Sets the value of the specified key to null. (Inherited from NSObject) |
| SetPauseHandler(Action) | |
| SetResumingHandler(Action) | |
| SetUserInfo(NSObject, NSString) | |
| SetValueForKey(NSObject, NSString) |
Sets the value of the property specified by the key to the specified value. (Inherited from NSObject) |
| SetValueForKeyPath(IntPtr, NSString) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject) |
| SetValueForKeyPath(NSObject, NSString) |
Sets the value of a property that can be reached using a keypath. (Inherited from NSObject) |
| SetValueForUndefinedKey(NSObject, NSString) |
Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject) |
| SetValuesForKeysWithDictionary(NSDictionary) |
Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject) |
| ToString() |
Returns a string representation of the value of the current instance. (Inherited from NSObject) |
| Unbind(NSString) | (Inherited from NSObject) |
| Unbind(String) |
Obsolete.
(Inherited from NSObject)
|
| Unpublish() | |
| ValueForKey(NSString) |
Returns the value of the property associated with the specified key. (Inherited from NSObject) |
| ValueForKeyPath(NSString) |
Returns the value of a property that can be reached using a keypath. (Inherited from NSObject) |
| ValueForUndefinedKey(NSString) |
Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject) |
| WillChange(NSKeyValueChange, NSIndexSet, NSString) |
Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject) |
| WillChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| WillChangeValue(String) |
Indicates that the value of the specified key is about to change. (Inherited from NSObject) |