CodecsOverlayData Class

Contains information about the overlay image found in the file.

Object Model

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public class CodecsOverlayData

'Declaration
 
Public Class CodecsOverlayData

'Usage
 
Dim instance As CodecsOverlayData

public sealed class CodecsOverlayData

function Leadtools.Codecs.CodecsOverlayData()

public ref class CodecsOverlayData

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)

Example

For an example, refer to RasterCodecs.StartOverlay

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

CodecsOverlayData Members
Leadtools.Codecs Namespace