CodecsDocLoadOptions Class

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public class CodecsDocLoadOptions

'Declaration
 
Public Class CodecsDocLoadOptions

'Usage
 
Dim instance As CodecsDocLoadOptions

public sealed class CodecsDocLoadOptions

function Leadtools.Codecs.CodecsDocLoadOptions()

public ref class CodecsDocLoadOptions

Microsoft Word 97-2003 (DOC) and Microsoft Word 2007/2010 (DOCX) files have no physical width or height in pixels. Use the CodecsRasterizeDocumentOptions to control how the final document is rendered as a raster image. For more information, refer to CodecsRasterizeDocumentLoadOptions.

For more information, refer to File Formats - DOC/DOCX Format.

Important note: The DOC/DOCX file format supports only the following rasterization size modes:

All other size modes will be treated as CodecsRasterizeDocumentSizeMode.Fit

DOC/DOCX also does not support loading a document using different horizontal or vertical resolutions. So if the value of CodecsRasterizeDocumentLoadOptions.XResolution and CodecsRasterizeDocumentLoadOptions.YResolution are different, the DOC/DOCX codecs will use the larger of the two values as the resolution to use when rasterizing.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs

Public Sub CodecsDocLoadOptionsExample()
   Dim codecs As New RasterCodecs()

   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.doc")

   ' Enable using the RasterizeDocumentOptions
   Dim rasterizeDocumentLoadOptions As CodecsRasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load
   ' Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio
   rasterizeDocumentLoadOptions.SizeMode = CodecsRasterizeDocumentSizeMode.Fit
   rasterizeDocumentLoadOptions.PageWidth = 8.5
   rasterizeDocumentLoadOptions.PageHeight = 11
   rasterizeDocumentLoadOptions.Unit = CodecsRasterizeDocumentUnit.Inch
   rasterizeDocumentLoadOptions.XResolution = 300
   rasterizeDocumentLoadOptions.YResolution = 300

   ' Load each page at 1-bits/pixel
   codecs.Options.Doc.Load.BitsPerPixel = 1

   ' Load the source file
   Using image As RasterImage = codecs.Load(srcFileName)
      ' Show the image information
      Console.WriteLine("Image has {0} pages", image.PageCount)
      Console.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI", _
         image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution)
   End Using

   ' Clean up
   codecs.Dispose()
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

using Leadtools;
using Leadtools.Codecs;

public void CodecsDocLoadOptionsExample()
{
    RasterCodecs codecs = new RasterCodecs();

    string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.doc");

    // Enable using the RasterizeDocumentOptions
    CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load;
    // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio
    rasterizeDocumentLoadOptions.SizeMode = CodecsRasterizeDocumentSizeMode.Fit;
    rasterizeDocumentLoadOptions.PageWidth = 8.5;
    rasterizeDocumentLoadOptions.PageHeight = 11;
    rasterizeDocumentLoadOptions.Unit = CodecsRasterizeDocumentUnit.Inch;
    rasterizeDocumentLoadOptions.XResolution = 300;
    rasterizeDocumentLoadOptions.YResolution = 300;

    // Load each page at 1-bits/pixel
    codecs.Options.Doc.Load.BitsPerPixel = 1;

    // Load the source file
    using (RasterImage image = codecs.Load(srcFileName))
    {
        // Show the image information
        Console.WriteLine("Image has {0} pages", image.PageCount);
        Console.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI",
           image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution);
    }

    // Clean up
    codecs.Dispose();
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

//CodecsOptionsExamples.prototype.CodecsDocLoadOptionsExample = function () {
//   Tools.SetLicense();
//   with (Leadtools) {
//      with (Leadtools.Codecs) {
//         var codecs = new RasterCodecs();

//         var srcFileName = "Assets\\Image1.doc";

//         // Enable using the RasterizeDocumentOptions
//         var rasterizeDocumentLoadOptions = codecs.options.rasterizeDocument.load;
//         // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio
//         rasterizeDocumentLoadOptions.sizeMode = CodecsRasterizeDocumentSizeMode.fit;
//         rasterizeDocumentLoadOptions.pageWidth = 8.5;
//         rasterizeDocumentLoadOptions.pageHeight = 11;
//         rasterizeDocumentLoadOptions.unit = CodecsRasterizeDocumentUnit.inch;
//         rasterizeDocumentLoadOptions.xresolution = 300;
//         rasterizeDocumentLoadOptions.yresolution = 300;

//         // Load each page at 1-bits/pixel
//         codecs.options.doc.load.bitsPerPixel = 1;

//         // Load the source file
//         return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
//            return codecs.loadAsync(LeadStreamFactory.create(loadFile))
//         })
//            .then(function (image) {

//               // Show the image information
//               console.info("Image has " + image.pageCount + " pages");
//               console.info("Image size: " + image.imageWidth + " by " + image.imageHeight + " pixels at " + image.xresolution + " by " + image.yresolution + " DPI");

//               image.close();
//               // Clean up
//               codecs.close();
//            });
//      }
//   }
//}

using Leadtools;
using Leadtools.Codecs;

      
public async Task CodecsDocLoadOptionsExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\Image1.doc";

   // Enable using the RasterizeDocumentOptions
   CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load;
   // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio
   rasterizeDocumentLoadOptions.SizeMode = CodecsRasterizeDocumentSizeMode.Fit;
   rasterizeDocumentLoadOptions.PageWidth = 8.5;
   rasterizeDocumentLoadOptions.PageHeight = 11;
   rasterizeDocumentLoadOptions.Unit = CodecsRasterizeDocumentUnit.Inch;
   rasterizeDocumentLoadOptions.XResolution = 300;
   rasterizeDocumentLoadOptions.YResolution = 300;

   // Load each page at 1-bits/pixel
   codecs.Options.Doc.Load.BitsPerPixel = 1;

   // Load the source file
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   using (RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile)))
   {
      // Show the image information
      Debug.WriteLine("Image has {0} pages", image.PageCount);
      Debug.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI",
         image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution);
   }

   // Clean up
   codecs.Dispose();
}

Target Platforms

Reference

CodecsDocLoadOptions Members
Leadtools.Codecs Namespace