Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Class CodecsOverlayData | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
| |
| C# | |
|---|---|
public class CodecsOverlayData | |
| Managed Extensions for C++ | |
|---|---|
public __gc 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 RasterImage object containing the loaded overlay image (Only Info is false) |
Inheritance Hierarchy
System.Object
Leadtools.Codecs.CodecsOverlayData
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family