[]
        
(Showing Draft Content)

C1.Win.C1Preview.VisitedDocument

VisitedDocument Class

Represents a document in the VisitedDocuments collection of a C1PreviewPane.

Inheritance
VisitedDocument
Namespace: C1.Win.C1Preview
Assembly: C1.Win.PrintPreview.8.dll
Syntax
public class VisitedDocument

Constructors

Name Description
VisitedDocument()

Properties

Name Description
DocumentCaption

Gets or sets the caption of the current visited document.

HasAutoDocumentCaption

Gets a value indicating whether the current visited document has an automatically generated name. That name is changed when the document is saved to file.

Index

Gets the index of the current object in the containing collection.

Owner

Gets the VisitedDocumentCollection containing the current visited document.

Pane

Gets the C1PreviewPane that is the owner of the VisitedDocumentCollection containing the current visited document.

Storage

Gets or sets the VisitedDocumentStorage object containing the data of the current visited document.

UserAction

Gets the action that caused the current visited document to be stored in history. This property is used to generate the string returned by the GetFullDocumentCaption() method.

Methods

Name Description
CreateDocument()

Creates an instance of the document that is stored in the current visited document.

Note that if the current visited document is linked with the document that is currently open in the preview pane, that document object is returned.

GetFullDocumentCaption()

Gets the caption representing the current visited document with description of the change that caused it to be saved appended.

For instance, if the current visited document was saved when the user changed page settings, the value of this property can be "Document1 (page settings changed)".