←Select platform

GetPropertyIdString Method

Summary
Gets the equivalent string for the passed property ID.

Syntax
C#
C++/CLI
Python
public static string GetPropertyIdString( 
   WiaPropertyId propertyId 
) 
public: 
static String^ GetPropertyIdString(  
   WiaPropertyId propertyId 
)  
def GetPropertyIdString(self,propertyId): 

Parameters

propertyId
The property ID for property ID string being sought. For a list of available property IDs, see WiaPropertyId.

Remarks

Call this function to get the equivalent string for the passed property ID through the propertyId parameter.

Use this function to get the property string to pass for any of the GetPropertyXXX or SetPropertyXXX methods.

Example
C#
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
WiaSession myWia_Session; 
 
public void GetPropertyLongExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version2)) 
   { 
      Console.WriteLine("WIA version 2.0 not installed."); 
      return; 
   } 
 
   myWia_Session = new WiaSession(); 
   myWia_Session.Startup(WiaVersion.Version2); 
 
   DialogResult res = myWia_Session.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault); 
   if (res != DialogResult.OK) 
   { 
      Console.WriteLine("Error selecting WIA device."); 
      myWia_Session.Shutdown(); 
      return; 
   } 
 
   object rootItem = myWia_Session.GetRootItem(null); 
   if (rootItem != null) 
   { 
      myWia_Session.EnumItemsEvent += new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent4); 
 
      myWia_Session.EnumChildItems(rootItem); 
 
      myWia_Session.EnumItemsEvent -= new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent4); 
   } 
 
   myWia_Session.Shutdown(); 
} 
 
void wiaSession_EnumItemsEvent4(object sender, WiaEnumItemsEventArgs e) 
{ 
   if (e.Item != null) 
   { 
      // Read the document handling select property. 
      int longValue = myWia_Session.GetPropertyLong(e.Item, null, WiaPropertyId.ScannerDeviceDocumentHandlingSelect); 
 
      // If the Feeder is not selected then select the Feeder. 
      if ((longValue & (int)WiaScanningModeFlags.Duplex) != (int)WiaScanningModeFlags.Duplex) 
      { 
         longValue = (int)WiaScanningModeFlags.Duplex; 
         myWia_Session.SetPropertyLong(e.Item, null, WiaPropertyId.ScannerDeviceDocumentHandlingSelect, longValue); 
      } 
 
      myWia_Session.FreeItem(e.Item); 
   } 
} 
Requirements

Target Platforms

Help Version 22.0.2023.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Wia Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.