LEADTOOLS WIA (Leadtools.Wia assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
AcquireFileEvent Event
See Also 
Leadtools.Wia Namespace > WiaSession Class : AcquireFileEvent Event



Occurs for each page acquired from the currently selected WIA source using the WiaSession.AcquireToFile method and it will also get called for each end of page to provide the user with the EndOfPage flag through the Flags member of the WiaAcquireFileEventArgs event argument to indicate the end of each page transfer.

Syntax

Visual Basic (Declaration) 
Public Event AcquireFileEvent As EventHandler(Of WiaAcquireFileEventArgs)
Visual Basic (Usage)Copy Code
Dim instance As WiaSession
Dim handler As EventHandler(Of WiaAcquireFileEventArgs)
 
AddHandler instance.AcquireFileEvent, handler
C# 
public event EventHandler<WiaAcquireFileEventArgs> AcquireFileEvent
C++/CLI 
public:
event EventHandler<WiaAcquireFileEventArgs^>^ AcquireFileEvent

Event Data

The event handler receives an argument of type WiaAcquireFileEventArgs containing data related to this event. The following WiaAcquireFileEventArgs properties provide information specific to this event.

PropertyDescription
Cancel Aborts the acquire operation.
FileName Indicates the full filename and path into which the current scanning operation is saving the page(s) that are being acquired.
Flags Indicates the start and the end of each acquired page.
Percent Indicates the percent completion of the acquisition process from the WIA source.

Example

Remarks

If the user acquired several pages at the same time, a separate event occurs for each page.

For more information, refer to How to Acquire from the WIA Source.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also