CodecsOverlayData Class

Summary

Contains information about the overlay image found in the file.

Syntax

Java

Objective-C

WinRT C#

C++

public class CodecsOverlayData

Public Class CodecsOverlayData

public sealed class CodecsOverlayData

@interface LTCodecsOverlayData : NSObject

public class CodecsOverlayData extends LeadEvent

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 RasterImage object containing the loaded overlay image (Only Info is false)