--- layout: default-layout needAutoGenerateSidebar: true needGenerateH3Content: true noTitleIndex: true title: Dynamsoft Document Viewer API Reference keywords: Documentation, Dynamsoft Document Viewer, API Reference breadcrumbText: API Reference description: Dynamsoft Document Viewer Documentation API Reference Page permalink: /api/index.html --- # API Reference ## Namespaces - [`Dynamsoft.DDV`](https://www.dynamsoft.com/document-viewer/docs/api/namespace/ddv.md) - [`Dynamsoft.DDV.Core`](https://www.dynamsoft.com/document-viewer/docs/api/namespace/ddv_core.md) - [`Dynamsoft.DDV.Elements`](https://www.dynamsoft.com/document-viewer/docs/api/namespace/ddv_elements.md) ## Classes - Dynamsoft.DDV - [DocumentManager](https://www.dynamsoft.com/document-viewer/docs/api/class/documentmanager.md) - [EditViewer](https://www.dynamsoft.com/document-viewer/docs/api/class/editviewer.md) - [CaptureViewer](https://www.dynamsoft.com/document-viewer/docs/api/class/captureviewer.md) - [PerspectiveViewer](https://www.dynamsoft.com/document-viewer/docs/api/class/perspectiveviewer.md) - [BrowseViewer](https://www.dynamsoft.com/document-viewer/docs/api/class/browseviewer.md) - Advanced - [ImageFilter](https://www.dynamsoft.com/document-viewer/docs/api/class/advanced/imagefilter.md) - [DocumentDetect](https://www.dynamsoft.com/document-viewer/docs/api/class/advanced/documentdetect.md) - Annotation - [Rectangle](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/rectangle.md) - [Redaction](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/redaction.md) - [Ellipse](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/ellipse.md) - [Polygon](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/polygon.md) - [Polyline](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/polyline.md) - [Line](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/line.md) - [Ink](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/ink.md) - [TextBox](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/textbox.md) - [TextTypewriter](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/texttypewriter.md) - [Stamp](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/stamp.md) - [Highlight](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/highlight.md) - [Underline](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/underline.md) - [Strikeout](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/strikeout.md) - [Incomplete](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/incomplete.md) - [Unknown](https://www.dynamsoft.com/document-viewer/docs/api/class/annotation/unknown.md) ## Interfaces - [`IDocument`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/index.md) - [`Source`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/source.md) - [`PdfSource`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/pdfsource.md) - [`SavePngSettings`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/savepngsettings.md) - [`SaveJpegSettings`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/savejpegsettings.md) - [`SaveTiffSettings`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/savetiffsettings.md) - [`SavePdfSettings`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/savepdfsettings.md) - [`CustomTag`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/customtag.md) - [`PrintSettings`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/printsettings.md) - [`IDocTextSearcher`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/idoctextsearcher.md) - Style Interfaces | Style Name | Style Interface | | -------------------- | ------------------------------------------------------------ | | `pageStyle` | [`BaseStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/basestyle.md) | | `currentPageStyle` | [`BaseStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/basestyle.md) | | `selectedPageStyle` | [`BaseStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/basestyle.md) | | `hoveredPageStyle` | [`BaseStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/basestyle.md) | | `placeholderStyle` | [`BaseStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/basestyle.md) | | `pageNumberStyle` | [`PageNumberStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/pagenumberstyle.md) | | `checkboxStyle` | [`CheckboxStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/checkboxstyle.md) | | `canvasStyle` | [`CanvasStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/canvasstyle.md) | | `quadSelectionStyle` | [`QuadSelectionStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/quadselectionstyle.md) | | `annotationSelectionStyle`| [`AnnotationSelectionStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/styleinterface/annotationselectionstyle.md) | - Annotation Interfaces - [`RectAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/rectannotationoptions.md) - [`EllipseAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/ellipseannotationoptions.md) - [`PolygonAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/polygonannotationoptions.md) - [`PolylineAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/polylineannotationoptions.md) - [`LineAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/lineannotationoptions.md) - [`InkAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/inkannotationoptions.md) - [`TextBoxAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/textboxannotationoptions.md) - [`TextTypewriterAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/texttypewriterannotationoptions.md) - [`StampAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/stampannotationoptions.md) - [`HighlightAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/highlightannotationoptions.md) - [`UnderlineAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/underlineannotationoptions.md) - [`StrikeoutAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/strikeoutannotationoptions.md) - [`RedactionAnnotationOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/redactionannotationoptions.md) - [`Flags`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/flags.md) - [`Point`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/point.md) - [`TextContent`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/textcontent.md) - [`RectangleStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/rectanglestyle.md) - [`EllipseStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/ellipsestyle.md) - [`PolygonStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/polygonstyle.md) - [`PolylineStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/polylinestyle.md) - [`LineStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/linestyle.md) - [`InkStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/inkstyle.md) - [`TextBoxStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/textboxstyle.md) - [`TextTypewriterStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/texttypewriterstyle.md) - [`StampStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/stampstyle.md) - [`HighlightStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/highlightstyle.md) - [`UnderlineStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/underlinestyle.md) - [`StrikeoutStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/strikeoutstyle.md) - [`RedactionStyle`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/rectanglestyle.md) - [`ToolbarConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/toolbarconfig.md) - [`PaletteConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/paletteconfig.md) - [`AnnotationToolbarButton`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationinterface/annotationtoolbarbutton.md) - [`AnnotationConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/annotationconfig.md) - [`BrowseViewerConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/browseviewerconfig.md) - [`BrowseViewerConstructorOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/browseviewerconstructoroptions.md) - [`CaptureViewerConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/captureviewerconfig.md) - [`CaptureViewerConstructorOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/captureviewerconstructoroptions.md) - [`ConfigResult`](https://www.dynamsoft.com/document-viewer/docs/api/interface/configresult.md) - [`CreateDocumentOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/createdocumentoptions.md) - [`CustomViewerConstructorOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/customviewerconstructoroptions.md) - [`DDVError`](https://www.dynamsoft.com/document-viewer/docs/api/interface/ddverror.md) - [`DetectResult`](https://www.dynamsoft.com/document-viewer/docs/api/interface/detectresult.md) - [`DisplayTextConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/displaytextconfig.md) - [`DocumentDetectConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/documentdetectconfig.md) - [`DocumentDetectResult`](https://www.dynamsoft.com/document-viewer/docs/api/interface/documentdetectresult.md) - [`EditViewerConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/editviewerconfig.md) - [`EditViewerConstructorOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/editviewerconstructoroptions.md) - [`IBrowseViewer`](https://www.dynamsoft.com/document-viewer/docs/api/interface/ibrowseviewer.md) - [`IImageFilter`](https://www.dynamsoft.com/document-viewer/docs/api/interface/iimagefilter.md) - [`IPointerEvent`](https://www.dynamsoft.com/document-viewer/docs/api/interface/ipointerevent.md) - [`IPageData`](https://www.dynamsoft.com/document-viewer/docs/api/interface/ipagedata.md) - [`IQuadModifiedEvent`](https://www.dynamsoft.com/document-viewer/docs/api/interface/iquadmodifiedevent.md) - [`ITextSearchedInfo`](https://www.dynamsoft.com/document-viewer/docs/api/interface/itextsearchedinfo.md) - [`ITextSelectedInfo`](https://www.dynamsoft.com/document-viewer/docs/api/interface/itextselectedinfo.md) - [`IDocumentDetect`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocumentdetect.md) - [`ImageFilterItem`](https://www.dynamsoft.com/document-viewer/docs/api/interface/imagefilteritem.md) - [`MergeDocumentOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/mergedocumentoptions.md) - [`PageImageInfo`](https://www.dynamsoft.com/document-viewer/docs/api/interface/pageimageinfo.md) - [`PageVisualInfo`](https://www.dynamsoft.com/document-viewer/docs/api/interface/pagevisualinfo.md) - [`PerspectiveViewerConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/perspectiveviewerconfig.md) - [`PerspectiveViewerConstructorOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/perspectiveviewerconstructoroptions.md) - [`PlayCallbackInfo`](https://www.dynamsoft.com/document-viewer/docs/api/interface/playcallbackinfo.md) - [`Rect`](https://www.dynamsoft.com/document-viewer/docs/api/interface/rect.md) - [`RectXY`](https://www.dynamsoft.com/document-viewer/docs/api/interface/rectxy.md) - [`SearchTextOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/searchtextoptions.md) - [`TextSearchResult`](https://www.dynamsoft.com/document-viewer/docs/api/interface/textsearchresult.md) - [`ThumbnailConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/thumbnailconfig.md) - [`Tooltip`](https://www.dynamsoft.com/document-viewer/docs/api/interface/tooltip.md) - [`TransferOptions`](https://www.dynamsoft.com/document-viewer/docs/api/interface/transferoptions.md) - [`UiConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/uiconfig.md) - [`UpdatedPdfSource`](https://www.dynamsoft.com/document-viewer/docs/api/interface/updatedpdfsource.md) - [`UpdatedSource`](https://www.dynamsoft.com/document-viewer/docs/api/interface/updatedsource.md) - [`VError`](https://www.dynamsoft.com/document-viewer/docs/api/interface/verror.md) - [`VideoConfig`](https://www.dynamsoft.com/document-viewer/docs/api/interface/videoconfig.md) - [`VideoDeviceInfo`](https://www.dynamsoft.com/document-viewer/docs/api/interface/videodeviceinfo.md) - [`VImageData`](https://www.dynamsoft.com/document-viewer/docs/api/interface/vimagedata.md) - [`ZoomOrigin`](https://www.dynamsoft.com/document-viewer/docs/api/interface/zoomorigin.md) ## Enumeration & Type - [`EnumPdfPageType`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumpdfpagetype.md) - [`EnumPdfCompressionType`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumpdfcompressiontype.md) - [`EnumTiffCompressionType`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumtiffcompressiontype.md) - [`EnumConvertMode`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumconvertmode.md) - [`EnumAnnotationRenderMode`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumannotationrendermode.md) - [`EnumImageDataType`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumimagedatatype.md) - [`EnumImageFilterType`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumimagefiltertype.md) - [`EnumDocumentDetectionStatus`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumdocumentdetectionstatus.md) - [`EnumStampIcon`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumstampicon.md) - [`EnumLineEnding`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/enumlineending.md) - [`type Quad`](https://www.dynamsoft.com/document-viewer/docs/api/enumeration-type/quad.md) ## Error - [Error List](https://www.dynamsoft.com/document-viewer/docs/api/errorlist.md)