DiGi.Tas.TIC.Classes

DiGi.Tas.TIC

DiGi.Tas.TIC.Classes Namespace

Classes

Document Class

Represents a document wrapper for TIC documents, providing functionality to load, save, and close the underlying document resource.

public class Document : DiGi.Tas.Core.Classes.Document<TIC.Document>

Inheritance System.Object → DiGi.Tas.Core.Classes.Document<TIC.Document> → Document

Constructors

Document() Constructor

Initializes a new instance of the Document class.

public Document();

Document(string, bool) Constructor

Initializes a new instance of the Document class with a specified file path and read-only status.

public Document(string path, bool readOnly=false);

Parameters

path System.String

The physical path to the document file.

readOnly System.Boolean

A value indicating whether the document should be opened in read-only mode.

Methods

Document.Close() Method

Closes the underlying TIC document resource.

public override void Close();

Document.Load(string) Method

Loads the document from the specified path or creates a new one if the file does not exist.

protected override bool Load(string? path=null);

Parameters

path System.String

The optional path to the document file to be loaded.

Returns

System.Boolean
true if the load operation was successful; otherwise, false.

Document.Save() Method

Saves the current state of the document to the disk if it is not read-only and exists.

public override bool Save();

Returns

System.Boolean
true if the document was saved successfully; otherwise, false.