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



item
Handle to the item having its properties set. Retrieve this parameter by either calling the WiaSession.GetRootItem method to get the device’s root item or by enumerating the child items of the device through a call to the Leadtools.Wia.WiaSession.EnumChildItems method.
properties
The properties to set.
item
Handle to the item having its properties set. Retrieve this parameter by either calling the WiaSession.GetRootItem method to get the device’s root item or by enumerating the child items of the device through a call to the Leadtools.Wia.WiaSession.EnumChildItems method.
properties
The properties to set.
Sets the values of the properties to the values specified in the WiaProperties structure into the WIA device’s item passed through the item parameter.

Syntax

Visual Basic (Declaration) 
Public Sub SetProperties( _
   ByVal item As Object, _
   ByVal properties As WiaProperties _
) 
Visual Basic (Usage)Copy Code
Dim instance As WiaSession
Dim item As Object
Dim properties As WiaProperties
 
instance.SetProperties(item, properties)
C# 
public void SetProperties( 
   object item,
   WiaProperties properties
)
C++/CLI 
public:
void SetProperties( 
   Object^ item,
   WiaProperties properties
) 

Parameters

item
Handle to the item having its properties set. Retrieve this parameter by either calling the WiaSession.GetRootItem method to get the device’s root item or by enumerating the child items of the device through a call to the Leadtools.Wia.WiaSession.EnumChildItems method.
properties
The properties to set.

Example

For an example, refer to WiaSession.GetRootItem.

Remarks

Add the WiaSession.SetPropertiesEvent event to be informed of any error codes returned from setting each property available in the WiaProperties structure, and to have the ability to cancel the process.

Note:

If the ShowUserInterface flag is set for any of the acquire methods, then be aware that some of the previously set/changed user properties (using any of the SetPropertyXxx or SetProperties methods) will be overwritten by the Microsoft's image acquisition dialog box. Microsoft's image acquisition dialog box sets its own initialization properties like the current intent (image type), selected area (left, top, width and height), paper source and duplex mode, ...etc.

To suppress the manufacturer’s image acquisition dialog and acquire directly from the specified source item through the item parameter using the values set through the SetPropertyXxx and SetProperties methods, do not set the ShowUserInterface flag.

For more information, refer to Managing WIA Sources.

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