LEADTOOLS Image File Support (Leadtools.Codecs assembly)
Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.5.11.4
| Leadtools.Codecs Namespace : CodecsDocumentImageInfo Class |
public class CodecsDocumentImageInfo
'Declaration Public Class CodecsDocumentImageInfo
'Usage Dim instance As CodecsDocumentImageInfo
public sealed class CodecsDocumentImageInfo
function Leadtools.Codecs.CodecsDocumentImageInfo()
public ref class CodecsDocumentImageInfo
LEADTOOLS provides support for loading a document as a raster image. Document formats such as PDF, XPS, DOC/DOCX(2007/2010), PPT/PPTX(2007/2010), XLS/XLSX(2007/2010), RTF and Text do not contain physical width, height or resolution. It is up to the loader (in this case, the RasterCodecs object) to specify the transformation from logical coordinates to physical pixels through a process called rasterization. For more information, refer to CodecsRasterizeDocumentLoadOptions.
The CodecsDocumentImageInfo class contains properties that specify the original document logical size on disk. This can be useful when calculating the rasterization parameters based on your application viewing needs. The CodecsDocumentImageInfo class contains the following members:
| Member | Description |
|---|---|
| IsDocumentFile |
true if the image file or stream passed to RasterCodecs.GetInformation or RasterCodecs.GetInformationAsync was a document file such as PDF or XPS and the other members of CodecsDocumentImageInfo are valid. false, otherwise. |
| PageWidth |
The original width of the document page in Unit |
| PageHeight |
The original height of the document page in Unit |
| Unit |
The unit for PageWidth and PageHeight |
These values specify the original size of the document on disk regardless of the settings of current document rasterization. The CodecsImageInfo.Width, CodecsImageInfo.Height, CodecsImageInfo.XResolution and CodecsImageInfo.YResolution contains the size of the final rasterized document in physical units.
The original document format is returned as usual in CodecsImageInfo.Format.
The CodecsDocumentImageInfo instance is returned in the CodecsImageInfo.Document property of the CodecsImageInfo object returned by all the RasterCodecs.GetInformation or RasterCodecs.GetInformationAsync methods.
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