# 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.

- **Product:** TX Text Control .NET Server
- **Section:** Reference
- **Kind:** Class
- **Introduced:** 15.0
- **Namespace:** `TXTextControl.DocumentServer.Web`
- **Package:** `TXTextControl.TextControl.ASP.SDK` (assembly `TXDocumentServer.Web.DocumentViewer.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXDocumentServer.Web.DocumentViewer.dll` from the setup
- **Inherits:** `System.Web.UI.WebControls.CompositeControl`
- **Path:** TX Text Control .NET Server > Reference > TXTextControl.DocumentServer.Web > DocumentViewer Class
- **2138 words**
- **Web URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/
- **LLMs URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/llms-full.txt

---

### Description

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.

### Syntax

```csharp
public class DocumentViewer : CompositeControl
```

```vbnet
Public Class DocumentViewer
    Inherits CompositeControl
```

### Examples

The legacy Web Forms document viewer type is not part of the current ASP.NET Core package. The following example uses the current MVC Document Viewer model for the same server-side workflow.

```csharp
TXTextControl.Web.MVC.DocumentViewer.DocumentViewer documentViewer = new();
Console.WriteLine("Document Viewer is ready for the document workflow.");
```

```vbnet
Dim documentViewer As New TXTextControl.Web.MVC.DocumentViewer.DocumentViewer()
Console.WriteLine("Document Viewer is ready for the document workflow.")
```

---

## In This Section

- [DocumentViewer Constructor](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/constructor/llms-full.txt): Initializes a new instance of the DocumentViewer class.
- [DocumentViewer.Dispose Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/dispose-method/llms-full.txt): Frees all resources used by the DocumentViewer instance.
- [DocumentViewer.DocumentController Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/documentcontroller-property/llms-full.txt): Gets or sets the DocumentServer.DocumentController object that is associated with the DocumentServer.Web.DocumentViewer component.
- [DocumentViewer.DocumentPath Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/documentpath-property/llms-full.txt): Gets 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 DocumentServer.Web.DocumentViewer is initialized. Please note that the extension of the specified filename must match the file's type, since the viewer determines the file type based on its extension and passes this information on to the DocumentServer.DocumentController which then in turn will try to load the document. Obviously, this process will fail, if the file extension suggests the wrong file type.
- [DocumentViewer.EditMode Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/editmode-property/llms-full.txt): Gets or sets whether the document viewer renders forms editable, i.e. with input fields at every form field's location, or read-only.
- [DocumentViewer.FieldBorderColor Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/fieldbordercolor-property/llms-full.txt): Gets or sets the color of the field borders, that is used when FieldBorderStyle is not None.
- [DocumentViewer.FieldBorderStyle Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/fieldborderstyle-property/llms-full.txt): Gets or sets whether and if so how the field borders are rendered, when EditMode is set to Edit.
- [DocumentViewer.Interpolation Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/interpolation-property/llms-full.txt): Gets or sets whether the rendered document is interpolated during the process. The higher the value, the better the quality, but also the slower the rendering process and vice versa.
- [DocumentViewer.InterpolationMode Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/interpolationmode-property/llms-full.txt): Gets or sets the interpolation mode which is used for rendering the document. This like DocumentServer.Web.DocumentViewer.Interpolation, this setting affects the rendering result.
- [DocumentViewer.LoadDocument Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/loaddocument-method/llms-full.txt): Loads a document that is used for further processing.
- [DocumentViewer.LoadDocumentFromMemory Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/loaddocumentfrommemory-method/llms-full.txt): Loads a document from a file that is used for further processing.
- [DocumentViewer.PageAnimationDuration Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/pageanimationduration-property/llms-full.txt): Gets or sets the duration of the page animations in seconds.
- [DocumentViewer.PageAnimations Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/pageanimations-property/llms-full.txt): Specifies whether CSS transition animations should be used or not when navigating through pages.
- [DocumentViewer.PageNumber Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/pagenumber-property/llms-full.txt): Gets or sets the page number that the DocumentServer.Web.DocumentViewer is displaying or should display respectively. Returns 0, if no document is loaded.
- [DocumentViewer.RoundedPageCorners Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/roundedpagecorners-property/llms-full.txt): Specifies whether rounded document page corners should be used or not.
- [DocumentViewer.Save Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/save-method/llms-full.txt): Initiates saving the currently loaded document. The actual saving is performed by a method which has to be bound to the DocumentServer.Web.DocumentViewer.SaveDocument event.
- [DocumentViewer.SaveDocument Event](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/savedocument-event/llms-full.txt): Occurs when DocumentServer.Web.DocumentViewer.Save has been called, while specifying the format parameter only. The event handler receives an argument of type DocumentServer.Web.DocumentViewer.SaveDocumentEventArgs containing data related to this event.
- [DocumentViewer.SaveFormData Event](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/saveformdata-event/llms-full.txt): Occurs when DocumentServer.Web.DocumentViewer.SaveUserInput has been called. The event handler receives an argument of type DocumentServer.Web.DocumentViewer.SaveFormDataEventArgs containing data related to this event.
- [DocumentViewer.SaveUserInput Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/saveuserinput-method/llms-full.txt): Initiates saving the currently loaded form's user input. The actual saving is performed by a method which has to be bound to the DocumentServer.Web.DocumentViewer.SaveFormData event.
- [DocumentViewer.ShowEditButton Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/showeditbutton-property/llms-full.txt): Specifies whether the edit button is shown or not.
- [DocumentViewer.ToolBar Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/toolbar-property/llms-full.txt): Specifies whether the document viewer's tool bar is displayed or not.
- [DocumentViewer.TotalPages Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/totalpages-property/llms-full.txt): Gets the total number of pages the loaded document contains. Returns 0 if no document is loaded.
- [DocumentViewer.ZoomFactor Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/zoomfactor-property/llms-full.txt): Gets or sets the zoom factor in percent.
- [DocumentViewer.ZoomTo Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/zoomto-property/llms-full.txt): Gets or sets the zoom behavior of the DocumentServer.Web.DocumentViewer.

---

## Nearby

- **Previous:** [TXTextControl.DocumentServer.Web namespace](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/llms-full.txt)
- **Next:** [DocumentViewer Constructor](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol-documentserver-web/documentviewer/constructor/llms-full.txt)