Click or drag to resize
BaseDocument Class
Defines objects that represents a document.
Inheritance Hierarchy
SystemObject
  RasterEdge.Imaging.BasicBaseDocument
    More...

Namespace: RasterEdge.Imaging.Basic
Assembly: RasterEdge.Imaging.Basic (in RasterEdge.Imaging.Basic.dll) Version: 9.8.7.60526 (9.8.7.60526)
Syntax
public abstract class BaseDocument

The BaseDocument type exposes the following members.

Methods
  NameDescription
Public methodAddPage
Appends a new page to the end of the document. Throw an exception in condition: 1. page type is conflict to the document type.
Public methodAddPages
Appends the pages to the end of the document. Throw an exception in condition: 1. page type is conflict to the document type.
Public methodAppendDocument
Appends a document off the same type to the end of the original document. Throw an exception in condition: 1. document type is conflict
Public methodBurnAnnotation
Burns all annotations to pages in the document.
Public methodCacheSearchInfo(String)
Public methodCacheSearchInfo(String, Int32, Int32)
Public methodClone
Creates an exact copy of this document object.
Public methodConvertToDocument(DocumentType, Stream)
Converts document to the target file format and saves it into a stream. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, String)
Converts document to the target file format and saves it to a file on the local disk. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, ImageCompress, Stream)
Converts document to the target file format and saves it to stream. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, ImageCompress, String)
Converts document to the target file format and saves it to a file on the local disk. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, Int32, Stream)
Converts document to the target file format with with sepcified zoom value and saves it to stream. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, Int32, String)
Converts document to the target file format with with sepcified zoom value and saves it to a file on the local disk. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, Stream, ImageOutputOption)
Converts document to the target file format and saves it into a stream with special output settings. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToDocument(DocumentType, Single, Stream)
Converts document to the target file format with with sepcified zoom value and saves it to stream. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added. 3: the zoom value is out of 10% ~ 2000%.
Public methodConvertToDocument(DocumentType, Single, String)
Converts document to the target file format with with sepcified zoom value and saves it to a file on the local disk. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added. 3: the zoom value is out of 10% ~ 2000%.
Public methodConvertToDocument(DocumentType, String, ImageOutputOption)
Converts document to the target file format and saves it into a stream with special output settings. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToHtml
Converts document to the Html(just only one .html)
Public methodConvertToImages(ImageType, Stream)
Converts document to images with specified type, one image per page, and store each image into a stream. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid resolution or zoom value input. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, ImageOutputOption, Stream)
Converts document to image streams with specified settings by Image Output Options. the image under a local file directory. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid directory or image options. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, Int32, Stream)
Converts document to images with specified type and resolution, one image per page, and store each image into a stream. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid resolution or zoom value input. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, Single, Stream)
Converts document to images with specified type and zoom value, one image per page, and store each image into a stream. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid resolution or zoom value input. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, String, String)
Converts document to images with sepcified type, one image per page, and store the image under a local file directory. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid resolution or zoom value input. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, ImageOutputOption, String, String)
Converts document to images with specified settings by Image Output Options. the image under a local file directory. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid directory or image options. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, Int32, String, String)
Converts document to images with sepcified type and resolution, one image per page, and store the image under a local file directory. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid resolution or zoom value input. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToImages(ImageType, Single, String, String)
Converts document to images with sepcified type and zoom value, one image per page, and store the image under a local file directory. Throw an exception in condition: 1. the required assembly has not been added. 2. invalid resolution or zoom value input. Default: zoom value = 1, resolution = 96 dpi.
Public methodConvertToVectorImages(ContextType, String, String, RelativeType)
Converts document to the target type file format with sepcified file name and saves it to a file on the local disk. Throw an exception in condition: 1: the target context type has not been developed yet. 2: the required assembly has not been added.
Public methodConvertToVectorImages(ContextType, String, String, RelativeType, RELength, RELength)
This interface should only implement by Excel project Converts document to the target type file format with sepcified file name and saves it to a file on the local disk. Throw an exception in condition: 1: the target context type has not been developed yet. 2: the required assembly has not been added.
Public methodDeletePage
Deletes an exist page at the specified page index. Throw an exception in condition: 1. page offset is out of range.
Public methodDeletePages
Deletes pages at the specified pageoffset, the number to delete is the pageCount. Throw an exception in condition: 1. page offset is out of range.
Public methodStatic memberDetermineDocumentType(Byte)
Determines the document type of the given data array.
Public methodStatic memberDetermineDocumentType(Stream)
Determines the document type of the given stream.
Public methodDispose
Releases all resources used by this document object.
Public methodDuplicatePage
Makes an deep copy of the page with specified index. Throw an exception in condition: 1. page index is out of range.
Public methodExtractPages(Int32, Stream)
Extracts pages from a document, form a new document and save it to a stream.
Public methodExtractPages(Int32, String)
Extracts pages from a document, form a new document and save it to a file.
Public methodGetCharsRectangle
Get char boundarys
Public methodGetDocumentType
Public methodGetFontGlyphWidths
Get this font all glyph widths in pixel
Public methodGetHyperlink
Get Hyperlink information in a Document
Public methodGetNewPage
Creates an empty page.
Public methodGetOutline
Gets document outline.
Public methodGetPage
Gets page form the page pool with the specified index.
Public methodGetPageCount
Gets the number page contained in the document.
Public methodInsertPage
Insert a new page at the specified page offset. Appends the page to the end of the document if the offset is out of range. Throw an exception in condition: 1. page type is conflict to the document type.
Public methodInsertPages
Insert the pages at the specified page offset. Appends the pages to the end of the document if the offset is out of range. Throw an exception in condition: 1. page type is conflict to the document type.
Public methodStatic memberIsDICOMDocument
Determins if the stream is not a DICOM file stream.
Public methodStatic memberIsDOCDocument
Determins if the stream is not a Office2003 DOC file stream.
Public methodStatic memberIsDOCXDocument
Determins if the stream is not a Office 2007 or later DOCX file stream.
Public methodStatic memberIsODPDocument
Determine if the stream is an open office presentation.
Public methodStatic memberIsODSDocument
Determine if the stream is an open office spreadsheet.
Public methodStatic memberIsODTDocument
Determine if the stream is an open office text document.
Public methodStatic memberIsOffice2003Document
Determine if the stream is a possible Office 2003 file stream.
Public methodStatic memberIsOfficeDocument
Determins if the stream is a possible Office Open XML file stream.
Public methodStatic memberIsOTPDocument
Determine if the stream is an open office template presentation.
Public methodStatic memberIsOTSDocument
Determine if the stream is an open office template spreadsheet.
Public methodStatic memberIsOTTDocument
Determine if the stream is an open office text template document.
Public methodIsPageExist
Determines if the page with specified index exists.
Public methodIsPageLoaded
Determins if the page with specified index is loaded with content.
Public methodStatic memberIsPDFDocument
Determines if the stream is not a PDF file stream.
Public methodStatic memberIsPPTDocument
Determins if the stream is not a Office2003 PPT file stream.
Public methodStatic memberIsPPTXDocument
Determins if the stream is not a Office PPTX file stream.
Public methodStatic memberIsRTFDocument
Public methodStatic memberIsTIFFDocument
Determins if the stream is not a TIFF file stream.
Public methodStatic memberIsXLSDocument
Determins if the stream is not a Office 2003 XLS file stream.
Public methodStatic memberIsXLSXDocument
Determins if the stream is not a Office XLSX file stream.
Public methodSave
Saves the document to file on the local disk with the given file path.
Public methodSaveToBytes
Saves the document to a byte array.
Public methodSaveToStream
Saves the doument to the stream.
Public methodStatic memberSearch
Public methodSetOutline
Sets document outline.
Public methodSortPage
Sorts the pages according to the page order. Throw an exception in condition: 1. index error.
Public methodSwapTwoPages
Swaps the order of two pages. Throw an exception in condition: 1. index error.
Public methodUpdatePage
Updates the old page with new page. Throw an exception in condition: 1. the new page is not in accordance with the document type.
Top
Properties
  NameDescription
Public propertySaveSVGJson
Top
See Also
Inheritance Hierarchy