TBinaryDocumentAncestor Class

Definition

Unit:: uDocumentsAncestor

Package:: Text2HTML

Manage documents as binary files. If you provide a private key they are encrypted with a XOR algorithm.

Delphi

type TBinaryDocumentAncestor = class(TDocumentAncestor)

Inheritance: TObject

TDocumentAncestor
TBinaryDocumentAncestor

Remarks

In your descendants, don't forget to override the methods GetDocumentGUID, GetDocumentExtension and GetPrivateXORKey

Constants

CBinaryDocumentVersion

Version level of this class. It is used to check compatibility between the program and the files it saves or tries to load.

Constructors

Create

Used to create a new instance of this class. It's better to use TDocument.DefaultDocument if you have only one document in your project, but create instances for each document if you want to edit more than one at the same time.

(Inherited from TDocumentAncestor)

Properties

FileName	The FileName for this document (no path, no extension) if opened by LoadFromFile(WithAName) or it has been saved by SaveToFile(WithAName) (Inherited from TDocumentAncestor)
HasChanged	Returns True if a document parameter has changed since last Clear(), LoadXXX() or SaveXXX() (Inherited from TDocumentAncestor)
Path	Path to the folder where this document will be saved. (Inherited from TDocumentAncestor)

Methods

Clear	Used to clean current instance and reset all properties and fields to their default values (Inherited from TDocumentAncestor)
GetDocumentExtension	Returns the file extension for the storrage file of this document. (Inherited from TDocumentAncestor)
GetDocumentGUID	Returns the unique identifier used in the document jeader to check if the file is compatible with this project. (Inherited from TDocumentAncestor)
GetPrivateXORKey	Returns the optional key to use to crypt/uncrypt the document file.
IsCrypted	Returns True if this document as a Private XOR Key and should by crypted
LoadFromFile(string)	Load this document from a file.
LoadFromStream(TStream)	Load the document content in this instance.
SaveToFile(string)	Save this document to a file.
SaveToStream(TStream)	Save this instance to the given stream.
SetHasChanged(Boolean)	(Inherited from TDocumentAncestor)