LEADTOOLS Image File Support (Leadtools.Codecs assembly)

TotalPercent Property (CodecsSaveImageEventArgs)

Show in webframe







Gets the overall completion percentage for the save operation.
Syntax
public int TotalPercent {get;}
'Declaration
 
Public ReadOnly Property TotalPercent As Integer
'Usage
 
Dim instance As CodecsSaveImageEventArgs
Dim value As Integer
 
value = instance.TotalPercent
public int TotalPercent {get;}
@property (nonatomic, readonly, assign) unsigned int totalPercent;
public int getTotalPercent()
 get_TotalPercent(); 
public:
property int TotalPercent {
   int get();
}

Property Value

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

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

When saving a multi-page file, PagePercent will go from 0 to 100 for each page saved while TotalPercent will go from 0 to 100 only once during the whole page operation. Usually, you will use TotalPercent to show an overall save 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 saving a single page file or one page to a multi-page file, both PagePercent and TotalPercent will go from 0 to 100 simultaneously.

Example
For an example, refer to RasterCodecs.SaveImage.
Requirements

Target Platforms

See Also

Reference

CodecsSaveImageEventArgs Class
CodecsSaveImageEventArgs Members

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.