IsDocumentFile Property

Summary

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

Syntax

Objective-C

C++

Java

public bool IsDocumentFile { get; }

Public ReadOnly Property IsDocumentFile As Boolean

@property (nonatomic, assign, readonly) BOOL isDocumentFile

public boolean 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