OfficeDecoder Class |
An implementation of the MultiFramedImageDecoder class allows to render MS Office documents without MS Office installed.
Inheritance HierarchySystemObject
Atalasoft.Imaging.CodecImageDecoder
Atalasoft.Imaging.CodecMultiFramedImageDecoder
Atalasoft.Imaging.CodecBaseCommonDecoder
Atalasoft.Imaging.CodecBaseCommonTextFormatDecoder
Atalasoft.Imaging.Codec.OfficeOfficeDecoder
Atalasoft.Imaging.CodecImageDecoder
Atalasoft.Imaging.CodecMultiFramedImageDecoder
Atalasoft.Imaging.CodecBaseCommonDecoder
Atalasoft.Imaging.CodecBaseCommonTextFormatDecoder
Atalasoft.Imaging.Codec.OfficeOfficeDecoder
Namespace: Atalasoft.Imaging.Codec.Office
Assembly: Atalasoft.dotImage.Office (in Atalasoft.dotImage.Office.dll) Version: 11.5.0.5.0.230 (.NET 4.6.2, x86)
SyntaxThe OfficeDecoder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OfficeDecoder |
Initializes a new instance of the OfficeDecoder class.
|
Properties| Name | Description | |
|---|---|---|
 | PageSize | Gets or sets decoded image page size (width and height values). Default values: Height = 0, Width = 0. (Overrides BaseCommonDecoderPageSize.) |
| RenderSettings |
Gets or sets render settings.
|
| Resolution |
Gets or sets a value that specifies the DPI to use when rendering a document. Default value is 96.
(Inherited from BaseCommonDecoder.) |
| SupportedImageType | Obsolete. Returns the ImageType that the implemented decoder class supports. (Inherited from ImageDecoder.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetFrameCount(Stream) | Returns the number of frames in the image (Overrides BaseCommonDecoderGetFrameCount(Stream).) |
| GetFrameCount(String) | Returns the number of frames in the image (Overrides BaseCommonDecoderGetFrameCount(String).) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetImageInfo(Stream) | Retrieve information from a file data stored in a Stream about the first frame. (Overrides BaseCommonDecoderGetImageInfo(Stream).) |
| GetImageInfo(String) | Retrieve information from a file about the first frame. (Overrides BaseCommonDecoderGetImageInfo(String).) |
| GetImageInfo(Stream, Int32) | Retrieve information from a file data stored in a Stream about specified frame. (Overrides BaseCommonDecoderGetImageInfo(Stream, Int32).) |
| GetImageInfo(String, Int32) | Retrieve information from a file about specified frame. (Overrides BaseCommonDecoderGetImageInfo(String, Int32).) |
| GetTextDocument(Stream) |
Creates the text document.
(Overrides BaseCommonTextFormatDecoderGetTextDocument(Stream).) |
| GetTextDocument(String) |
Creates the text document.
(Overrides BaseCommonTextFormatDecoderGetTextDocument(String).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsValidFormat(Stream) | Checks the stream to determine if the image can be read by the decoder that derives this class. (Overrides BaseCommonDecoderIsValidFormat(Stream).) |
| IsValidFormat(String) | Checks the stream to determine if the image can be read by the decoder that derives this class. (Overrides BaseCommonDecoderIsValidFormat(String).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Read(Stream, ProgressEventHandler) | Decode an image in a specified image Stream. (Inherited from BaseCommonDecoder.) |
| Read(String, ProgressEventHandler) | Decode an image from file. (Inherited from BaseCommonDecoder.) |
| Read(Stream, Int32, ProgressEventHandler) | Read a given frame in an encoded image using this decoder. (Overrides BaseCommonDecoderRead(Stream, Int32, ProgressEventHandler).) |
| Read(String, Int32, ProgressEventHandler) | Read a given frame from file using this decoder. (Overrides BaseCommonDecoderRead(String, Int32, ProgressEventHandler).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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:
<Atalasoft>
<OfficeDecoder LimitsPageCount="3000"/>
<!-- Components sections -->
...
</Atalasoft>See Also