DiGi.Tas.TBD.Classes

DiGi.Tas.TBD

DiGi.Tas.TBD.Classes Namespace

Classes

Document Class

Provides functionality for managing TBD documents, including loading, saving, and closing operations.

public class Document : DiGi.Tas.Core.Classes.Document<TBD.TBDDocument>

Inheritance System.Object → DiGi.Core.Interfaces.IObject → DiGi.Tas.Core.Classes.Document<TBD.TBDDocument> → 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 file system path to the document.

readOnly System.Boolean

Indicates whether the document should be opened in read-only mode.

Methods

Document.Close() Method

Closes the underlying TBD document instance.

public override void Close();

Document.Load(string) Method

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

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

Parameters

path System.String

The optional file system path to load. If null or empty, no loading is performed.

Returns

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

Document.Save() Method

Saves the current state of the TBD document to disk.

public override bool Save();

Returns

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