←Select platform

SetDocument Method

Summary

Sets a new document in the viewer.

Syntax
C#
VB
C++
public virtual void SetDocument( 
   LEADDocument document 
) 
Public Overridable Sub SetDocument( 
   ByVal document As LEADDocument 
) 
public:  
   virtual void SetDocument( 
      LEADDocument^ document 
   ) 

Parameters

document

Document object to view. Use null to remove the current document from the viewer.

Remarks

If the value of document is null, then the current document is removed from the viewer.

If the viewer has a previous LEADDocument object set and this method was sucessful, then the existing LEADDocument object will be disposed if the value of AutoDisposeDocument is true.

The viewer will check if the value of document is the same as the existing one in the viewer. If so, it will not dispose the old document. The application can set the same document in the viewer as a "reset" or "reload" operation.

Encrypted document's must be decrypted prior to setting them in the viewer. Refer to Loading Encrypted Files Using the Document Library for more information.

This method performs the following:

  1. ViewThe Operation is invoked with DocumentViewerOperation.SetDocument, Data1 set to document and IsPostOperation set to false.

  2. View, Thumbnails, Bookmarks and Annotations all may have background threads working to parse the existing document data. The document viewer will notify each object to abandon the work and exit the threads. This is performed in a graceful manner to preserve system resources and prevent memory leaks. Therefore, a slight delay might occur while the viewer waits on the threads to exit.

  3. If the existing LEADDocument is not null, not the same as document and the value of AutoDisposeDocument is true; then the LEADDocument object is disposed.

  4. View, Thumbnails, Bookmarks and Annotations will be notified that a new document is set and to start new background threads if needed or populate the UI elements from the document pages and data.

  5. ViewFinally, the Operation is invoked again with DocumentViewerOperation.SetDocument, Data1 set to document and IsPostOperation set to true this time.

Example

For an example, refer to DocumentViewer.

Requirements

Target Platforms

Help Version 21.0.2020.9.23
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Viewer.WinForms Assembly