LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
CodecsOverlayData Class
See Also  Members  
Leadtools.Codecs Namespace : CodecsOverlayData Class



Contains information about the overlay image found in the file.

Object Model

CodecsOverlayData Class

Syntax

Visual Basic (Declaration) 
Public Class CodecsOverlayData 
Visual Basic (Usage)Copy Code
Dim instance As CodecsOverlayData
C# 
public class CodecsOverlayData 
C++/CLI 
public ref class CodecsOverlayData 

Example

For an example, refer to RasterCodecs.StartOverlay

Remarks

An CodecsOverlayData object is populated and passed as data to the CodecsOverlayCallback parameter passed to the RasterCodecs.StartOverlay method. Some members of this class are for input some are for output as follows:

Member Description
FileName (Input) The name of the file containing the overlay image
PageNumber (Input) Page number of the requested overlay image
Info (Input) Determines whether overlay image info or actual image is needed
InfoWidth (Output) Overlay image width in pixels (Ignore if Info is false)
InfoHeight (Output) Overlay image height in pixels (Ignore if Info is false)
InfoXResolution (Output) Overlay image horizontal resolution in pixels per inch (Ignore if Info is false)
InfoYResolution (Output) Overlay image vertical resolution in pixels per inch (Ignore if Info is false)
Image (Output) The Leadtools.RasterImage object containing the loaded overlay image (Only Info is false)

Inheritance Hierarchy

System.Object
   Leadtools.Codecs.CodecsOverlayData

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also