SetPropertiesEvent Event

Occurs while setting each property inside the WiaProperties structure after calling the SetProperties method.

Syntax

Visual Basic
C#
Objective-C
Java
C++

public event EventHandler<WiaSetPropertiesEventArgs> SetPropertiesEvent

'Declaration
 
Public Event SetPropertiesEvent As EventHandler(Of WiaSetPropertiesEventArgs)

'Usage
 
Dim instance As WiaSession
Dim handler As EventHandler(Of WiaSetPropertiesEventArgs)
 
AddHandler instance.SetPropertiesEvent, handler

public:
event EventHandler<WiaSetPropertiesEventArgs^>^ SetPropertiesEvent

Event Data

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

Property	Description
Error	Gets the returned error code for each property being set.
PropertyId	Gets the property ID for the property being set.
Stop	Enables or disables firing the SetPropertiesEvent event.
Value	Gets the property value for the property being set.
ValueType	Gets the type of the property being set.

Remarks

This event will be called while setting each property inside the WiaProperties structure after calling the SetProperties method to provide the user with information about the return error, the property Id, the property value and property variable type and also gives the ability to abort the properties setting process.

Example

Refer to WiaSession.GetRootItem.Refer to WiaSession.GetRootItem.

Requirements

Target Platforms

Reference

WiaSession Class
WiaSession Members
Startup Method
Shutdown Method
GetRootItem Method
GetProperties Method
SetProperties Method
EnumChildItems Method