LEADTOOLS Image File Support (Leadtools.Codecs assembly)

IsDocumentFile Property

Show in webframe







Gets a value indicating whether the image file or stream is a document format.
Syntax
public bool IsDocumentFile {get;}
'Declaration
 
Public ReadOnly Property IsDocumentFile As Boolean
'Usage
 
Dim instance As CodecsDocumentImageInfo
Dim value As Boolean
 
value = instance.IsDocumentFile
public bool IsDocumentFile {get;}
@property (nonatomic, assign, readonly) BOOL isDocumentFile;

            
 get_IsDocumentFile(); 
public:
property bool IsDocumentFile {
   bool get();
}

Property Value

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

When the value of IsDocumentFile is true, then the image file or stream passed to the RasterCodecs.GetInformation or RasterCodecs.GetInformationAsync 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.

Example
For an example, refer to CodecsDocumentImageInfo.
Requirements

Target Platforms

See Also

Reference

CodecsDocumentImageInfo Class
CodecsDocumentImageInfo Members
CodecsRasterizeDocumentLoadOptions Class

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.