SetProperties Method

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
C#
WinRT C#
WinRT JavaScript
C++

public void SetProperties( 
   object item,
   WiaProperties properties
)

'Declaration
 
Public Sub SetProperties( _
   ByVal item As Object, _
   ByVal properties As WiaProperties _
)

'Usage
 
Dim instance As WiaSession
Dim item As Object
Dim properties As WiaProperties
 
instance.SetProperties(item, properties)

public void SetProperties( 
   object item,
   WiaProperties properties
)

 function Leadtools.Wia.WiaSession.SetProperties( 
   item ,
   properties 
)

public:
void SetProperties( 
   Object^ item,
   WiaProperties properties
)

Parameters

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

Remarks

Add the Leadtools.Wia.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.

Example

For an example, refer to WiaSession.GetRootItem.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

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