Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
IsDocumentFile Property
See Also 
Leadtools.Codecs Namespace > CodecsDocumentImageInfo Class : IsDocumentFile Property



Gets a value indicating whether the image file or stream is a document format.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property IsDocumentFile As Boolean
Visual Basic (Usage)Copy Code
Dim instance As CodecsDocumentImageInfo
Dim value As Boolean
 
value = instance.IsDocumentFile
C# 
public bool IsDocumentFile {get;}
C++/CLI 
public:
property bool IsDocumentFile {
   bool get();
}

Return Value

true if the image file or stream is a document format, false; otherwise.

Example

For an example, refer to CodecsDocumentImageInfo.

Remarks

When the value of IsDocumentFile is true, then the image file or stream passed to the RasterCodecs.GetInformation is a document file such as PDF or XPS. The rest of the members of this class are valid and contain the original document logical size. The physical load (rasterization size) is calculated based on the current rasterization values and is stored in CodecsImageInfo.Width, CodecsImageInfo.Height, CodecsImageInfo.XResolution and CodecsImageInfo.YResolution. For more information, refer to CodecsRasterizeDocumentLoadOptions.

If the value of IsDocumentFile is false, then the image file or stream is a raster image such as JPEG or TIFF. These files have physical size and the rest of the values of this class should not be used.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also