LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
TotalPercent Property
See Also 
Leadtools.Codecs Namespace > CodecsLoadImageEventArgs Class : TotalPercent Property



Gets the overall completion percentage for the load operation.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property TotalPercent As Integer
Visual Basic (Usage)Copy Code
Dim instance As CodecsLoadImageEventArgs
Dim value As Integer
 
value = instance.TotalPercent
C# 
public int TotalPercent {get;}
C++/CLI 
public:
property int TotalPercent {
   int get();
}

Property Value

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

Example

For an example, refer to RasterCodecs.LoadImage.

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 simultunasouly.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also