Click or drag to resize

OfficeDecoder Class

An implementation of the MultiFramedImageDecoder class allows to render MS Office documents without MS Office installed.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.CodecImageDecoder
    Atalasoft.Imaging.CodecMultiFramedImageDecoder
      Atalasoft.Imaging.Codec.OfficeOfficeDecoder

Namespace:  Atalasoft.Imaging.Codec.Office
Assembly:  Atalasoft.dotImage.Office (in Atalasoft.dotImage.Office.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
Copy
public class OfficeDecoder : MultiFramedImageDecoder, 
	ITextFormatDecoder

The OfficeDecoder type exposes the following members.

Constructors
  NameDescription
Public methodOfficeDecoder
Initializes a new instance of the OfficeDecoder class.
Top
Properties
  NameDescription
Public propertyRenderSettings
Gets or sets render settings.
Public propertyResolution
Gets or sets a value that specifies the DPI to use when rendering a document. Default value is 96.
Public propertySupportedImageType Obsolete.
Returns the ImageType that the implemented decoder class supports.
(Inherited from ImageDecoder.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFrameCount
Returns the number of frames in the image
(Overrides MultiFramedImageDecoderGetFrameCount(Stream).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetImageInfo(Stream)
Retrieve information from an image stored in a file without decoding the image data.
(Overrides ImageDecoderGetImageInfo(Stream).)
Public methodGetImageInfo(Stream, Int32) (Overrides MultiFramedImageDecoderGetImageInfo(Stream, Int32).)
Public methodGetTextDocument
Creates the text document.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidFormat
Checks the stream to determine if the image can be read by the decoder that derives this class.
(Overrides ImageDecoderIsValidFormat(Stream).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRead(Stream, ProgressEventHandler)
Decode an image in a specified image Stream.
(Overrides ImageDecoderRead(Stream, ProgressEventHandler).)
Public methodRead(Stream, Int32, ProgressEventHandler)
Read a given frame in an encoded image using this decoder.
(Overrides MultiFramedImageDecoderRead(Stream, Int32, ProgressEventHandler).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
By default this decoder renders only 3000 pages. To extend this limit see the 'example section.
Examples
To configure page limit, you should add the next line to app.config file:
Copy
<Atalasoft>
    <OfficeDecoder LimitsPageCount="3000"/>
    <!-- Components sections -->
    ...
</Atalasoft>
See Also