VersionControlManager Class |
Base class for classes for managing version control for documents and catalogs.
Provides a partial generic implementation of IVersionControl, allowing subclasses to provide specifics relating to documents and catalogs.
Inheritance HierarchySystemObject
Demo3D.Gui.VersionControlVersionControlManager
Demo3D.Gui.VersionControlVersionControlManager
Namespace: Demo3D.Gui.VersionControl
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 18.03.00
SyntaxC#
public abstract class VersionControlManager : IDisposable
The VersionControlManager type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DefaultEmailAddress |
The default Git email address to use.
|
| DefaultUsername |
The default Git user name to use.
|
| HasUncommittedChanges |
Whether this document has any uncommitted changes.
|
| IsVersionControlEnabled |
Whether version control is enabled for this document.
|
| RepositoryPath |
When implemented in a derived class, gets 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.
|
| Dispose |
Unsubscribes from the file watcher.
|
 | Dispose(Boolean) |
Unsubscribes from the file watcher.
|
| 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 |
When implemented in a derived class, 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 |
When implemented in a derived class, 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 outside Emulate3D.
|
See Also