PagePercent Property

Summary

Gets the load completion percentage of the current page.

Syntax

Java

Objective-C

WinRT C#

C++

public int PagePercent { get; }

Public ReadOnly Property PagePercent As Integer

public int PagePercent {get;}

@property (nonatomic, assign, readonly) NSUInteger pagePercent

public int getPagePercent()

 get_PagePercent();

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

Property Value

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

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 multi-page 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 multi-page 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 multi-page file, both PagePercent and TotalPercent will go from 0 to 100 simultaneously.

Example

For an example, refer to RasterCodecs.LoadImage.

Requirements

Target Platforms