TotalPercent Property

Summary

Gets the overall completion percentage for the load operation.

Syntax

Objective-C

C++

Java

public int TotalPercent { get; }

Public ReadOnly Property TotalPercent As Integer

@property (nonatomic, assign, readonly) NSUInteger totalPercent

public int getTotalPercent()

public: 
property int TotalPercent { 
   int get(); 
}

Property Value

A number between 0 and 100 that indicates the overall completion percentage of the load operation.

Remarks

Using the PagePercent and TotalPercent properties, you can use the CodecsLoadImageEventArgs to show a progress bar of the current load operation.

When loading a multipage file, PagePercent will go from 0 to 100 for each page loaded while TotalPercent will go from 0 to 100 only once during the whole page operation. Usually, you will use TotalPercent to show an overall load progress if the multipage image is considered to be one document. If however, individual progress is required for each page, then you can track the PagePercent property as well.

When loading a single page file or one page from a multipage file, both PagePercent and TotalPercent will go from 0 to 100 simultaneously.

Example

For an example, refer to RasterCodecs.LoadImage.

Requirements

Target Platforms