Leadtools.Wia Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
Format Property
See Also 
Leadtools.Wia Namespace > WiaDataTransferProperties Structure : Format Property



Gets or sets the preferred image format to use when performing data transfer from WIA source.

Syntax

Visual Basic (Declaration) 
Public Property Format As WiaFileFormats
Visual Basic (Usage)Copy Code
Dim instance As WiaDataTransferProperties
Dim value As WiaFileFormats
 
instance.Format = value
 
value = instance.Format
C# 
public WiaFileFormats Format {get; set;}
C++/CLI 
public:
property WiaFileFormats Format {
   WiaFileFormats get();
   void set (WiaFileFormats value);
}

Return Value

The preferred image format to use when performing data transfer from WIA source. Possible values are (according to Microsoft SDK documentation):

WiaFileFormats.None

 Use this value only to determine whether the WiaDataTransferProperties structure is filled with a valid format.

WiaFileFormats.MemoryBmp

 Windows bitmap without a header file (use this format when doing memory transfer).

WiaFileFormats.Bmp

 Windows bitmap with a header file.

WiaFileFormats.Ciff

 Camera Image File format (not supported in Windows Vista).

WiaFileFormats.Emf

 Extended Windows metafile.

WiaFileFormats.Exif

 Exchangeable File Format.

WiaFileFormats.Fpx

 FlashPix format.

WiaFileFormats.Gif

 GIF image format.

WiaFileFormats.Ico

 Windows icon file format.

WiaFileFormats.Jbig

 The Joint Bi-level Image Experts Group (JBIG) format (supported only in Windows Vista and later).

WiaFileFormats.Jpeg

 JPEG compressed format.

WiaFileFormats.J2k

 JPEG 2000 compressed format.

WiaFileFormats.J2kx

 JPEG 2000 compressed format.

WiaFileFormats.Pcd

 Eastman Kodak file format.

WiaFileFormats.Pct

 Apple file format.

WiaFileFormats.Png

 W3C PNG format.

WiaFileFormats.Raw

 Raw format for data transfers only.

WiaFileFormats.RawRgb

 Raw RGB format.

WiaFileFormats.Tiff

 Tag Image File Format.

WiaFileFormats.Wmf

 Windows metafile.

WiaFileFormats.Rtf

 Rich Text File format.

WiaFileFormats.Xml

 XML file.

WiaFileFormats.Html

 HTML format.

WiaFileFormats.Txt

 Text file.

WiaFileFormats.Pdfa

 The PDF/A (ISO/CD 19005-1) format (supported only in Windows Vista and later).

WiaFileFormats.Xps

 XML Paper Specification (XPS) Package format (supported only in Windows Vista and later).

WiaFileFormats.Mpg

 MPEG video format (not supported in either Windows Server 2003 or Windows Vista).

WiaFileFormats.Avi

 AVI video format (not supported in either Windows Server 2003 or Windows Vista).

WiaFileFormats.Wav

 WAV audio format.

WiaFileFormats.Mp3

 MP3 audio format.

WiaFileFormats.Aiff

 AIFF audio format.

WiaFileFormats.Wma

 WMA audio format.

WiaFileFormats.Asf

 ASF video format (not supported in either Windows Server 2003 or Windows Vista).

WiaFileFormats.Script

 Script file.

WiaFileFormats.Exec

 Executable file.

WiaFileFormats.Unicode16

 UNICODE 16-bit encoding.

WiaFileFormats.Dpof

 DPOF printing format.

For more information about these compression types, please refer to WIA_IPA_FORMAT property ID in Microsoft Windows SDK Documentation.

Example

Refer to WiaSession.GetRootItem example.

Requirements

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

See Also