TX Text Control .NET for Windows Forms Documentation

DocumentServer.Web.DocumentViewer Class

The DocumentViewer class is a .NET component that can be used to display documents in the web browser in ASP.NET projects. The DocumentViewer class can be found in the TXTextControl.DocumentViewer.Web namespace. It is derived from the System.Web.UI.WebControls.CompositeControl class. The following describes only the properties and methods directly defined by the DocumentViewer class. For a list of properties, methods and events inherited from the System.Web.UI.WebControls.CompositeControl class see the .NET Framework reference.

Introduced: 15.0.

Syntax

[C#] public class DocumentViewer : CompositeControl
[Visual Basic] Public Class DocumentViewer Inherits CompositeControl

Constructors

ConstructorDescription
DocumentServer.Web.DocumentViewerInitializes a new instance of the DocumentViewer class.

Properties

PropertyDescription
DocumentControllerGets or sets the DocumentServer.DocumentController object that is associated with the DocumentServer.Web.DocumentViewer component.
DocumentPathGets or sets the path to the document, which will be displayed in the DocumentServer.Web.DocumentViewer. The document will be processed and displayed the next time the
EditModeGets or sets whether the document viewer renders forms editable, i.e.
FieldBorderColorGets or sets the color of the field borders, that is used when FieldBorderStyle is not None.
FieldBorderStyleGets or sets whether and if so how the field borders are rendered, when EditMode is set to Edit.
InterpolationGets or sets whether the rendered document is interpolated during the process.
InterpolationModeGets or sets the interpolation mode which is used for rendering the document.
PageNumberGets or sets the page number that the DocumentServer.Web.DocumentViewer is displaying or should display respectively.
ToolBarSpecifies whether the document viewer's tool bar is displayed or not.
TotalPagesGets the total number of pages the loaded document contains.
ZoomFactorGets or sets the zoom factor in percent.
ZoomToGets or sets the zoom behavior of the DocumentServer.Web.DocumentViewer.

Methods

MethodDescription
DisposeFrees all resources used by the DocumentViewer instance.
LoadDocumentLoads a document from a file that is used for further processing.
LoadDocumentFromMemoryLoads a document from a file that is used for further processing.
SaveInitiates saving the currently loaded document.
SaveUserInputInitiates saving the currently loaded form's user input.

Events

EventDescription
SaveDocumentOccurs when DocumentServer.Web.DocumentViewer.Save has been called, while specifying the format parameter only.
SaveFormDataOccurs when DocumentServer.Web.DocumentViewer.SaveUserInput has been called.

See Also

 
 
 

Products

Support

Downloads

Corporate

Buy Now