TX Text Control .NET Server

DocumentPath Property

Property|Introduced in 15.0
Not found
No package of this release declares this member on this type or on a class it derives from.
Namespace
TXTextControl.DocumentServer.Web
Package
TXTextControl.TextControl.ASP.SDK as TXDocumentServer.Web.DocumentViewer.dll from the private NuGet feed or Text Control Offline Packages

Description

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.

Syntax

No package of this release declares this member. The declaration below is the reference's, and code that uses it does not compile.

public string DocumentPath { get; set; }

Examples

DocumentServer.Web.DocumentViewer.DocumentPath belongs to the legacy Web Forms viewer. In the current ASP.NET Core viewer, configure the server-rendered component through DocumentViewerSettings.DocumentPath; interactive page state and styling are handled by the viewer client.

documentViewerSettings.DocumentPath = @"App_Data\document.docx";
if (!string.IsNullOrWhiteSpace(documentViewerSettings.DocumentPath))
{
    Console.WriteLine($"Document Path: {documentViewerSettings.DocumentPath}");
}