IVersion |
Interface for documents which can be subject to version control.
Namespace: Demo3D.Common
Assembly: Demo3D.Common (in Demo3D.Common.dll) Version: 19.00.00
SyntaxC#
public interface IVersionControl : IDisposable
The IVersionControl type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DefaultEmailAddress | The default Git email address to use. |
| DefaultUsername | The default Git user name to use. |
| DocumentPath | The name of this version controlled document. |
| HasUncommittedChanges | Whether this document currently has any uncommitted changes. |
| HasUnsavedChanges | Whether this document currently has any unsaved changes. |
| IsVersionControlEnabled | Whether version control is enabled. |
| Name | The name of this version controlled document. |
| RepositoryPath | The full path of the root folder of the repository. |
Methods| Name | Description | |
|---|---|---|
 | CheckoutBranchAsync | Checks out a specified branch. Note that any unsaved or uncommitted changes will be lost. |
| CheckoutCommitAsync | Checks out a specified commit, resulting in a detached HEAD. Note that any unsaved or uncommitted changes will be lost. |
| CommitAsync | Commits all current changes. |
| EnableVersionControl | Enables version control for this document. |
| MakeSubfoldersNotReadOnly | Removes the read-only attribute from all subfolders. OneDrive often likes to make folders read-only, so for models/catalogs saved to OneDrive, the subfolders are often automatically read-only. This causes problems for Git, as it needs to be able to delete the folders when checking out a commit, so we need to remove the read-only attribute. |
| Reload | Reloads the current document. |
| RevertToCommitAsync | Reverts to a specified commit by creating a new commit that reverts all more recent commits. Note that any unsaved or uncommitted changes will be lost. |
| SaveChanges | Saves any unsaved changes. |
| ShowCommitDifferences | Shows visually the differences between two versions of a specified file. |
| ShowLocalDifferences | Shows visually the differences between the local copy and the last committed version of a file. |
| SuspendCommitChangedExternally | Gets an IDisposable instance which will disable publishing of the CommitChangedExternally event and re-enable when disposed. |
| UndoLocalChangesAsync | Deletes all local changes. |
Events| Name | Description | |
|---|---|---|
 | CommitChangedExternally | Occurs when an external version control operation results in checking out a different commit. |
| RepositoryModifiedExternally | Occurs when something is modified in the version control repository. |
See Also