StatusGuiCommand Class

Summary

Implements the TortoiseHg "status" command: Show working copy status.
Assembly
Mercurial.Net.dll
Namespace
Mercurial.Gui
Interfaces
Base Types
graph TD Base0["FilesBasedGuiCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial.Gui/FilesBasedGuiCommandBase_1" Base1["GuiCommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial.Gui/GuiCommandBase_1" Base2["CommandBase<T>"]-->Base1 click Base2 "/Cake.Hg/api/Mercurial/CommandBase_1" Base3["object"]-->Base2 Interface0["IGuiCommand"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial.Gui/IGuiCommand" Interface1["ICommand"]-.->Type click Interface1 "/Cake.Hg/api/Mercurial/ICommand" Type["StatusGuiCommand"] class Type type-node

Syntax

public sealed class StatusGuiCommand : FilesBasedGuiCommandBase<StatusGuiCommand>, IGuiCommand, 
    ICommand

Constructors

Name Summary
StatusGuiCommand() Initializes a new instance of the StatusGuiCommand class.

Properties

Name Value Summary
AdditionalArguments Collection<T>
Gets the collection which additional arguments can be added into. This collection is exposed for extensions, so that they have a place to add all their extra arguments to the Mercurial command line client.
Inherited from CommandBase<T>
Arguments IEnumerable<T>
Gets all the arguments to the Command, or an empty array if there are none.
Command string
Gets the command to execute with the Mercurial command line client.
Inherited from CommandBase<T>
DebugOutput bool
Gets or sets a value indicating whether to enable debug output on the command. This should only be used by the command code itself, never by the user.
Inherited from CommandBase<T>
Files Collection<T>
Gets the collection of files to pass to the command.
IsAvailable bool
Gets a value indicating whether the given command is available.
Inherited from GuiCommandBase<T>
static
Observer IMercurialCommandObserver
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase<T>
RawExitCode int
Gets the raw exit code from executing the command line client.
Inherited from CommandBase<T>
RawStandardErrorOutput string
Gets the raw standard error output from executing the command line client.
Inherited from CommandBase<T>
RawStandardOutput string
Gets the raw standard output from executing the command line client.
Inherited from CommandBase<T>
ShowClean bool
Gets or sets a value indicating whether to show files without changes. Default is false.
ShowIgnored bool
Gets or sets a value indicating whether to show ignored files. Default is false.
Timeout int
Gets or sets the timeout to use when executing Mercurial commands, in seconds. Default value for all Gui commands is 0, which translates to infinite timeout.
Inherited from GuiCommandBase<T>
WaitForGuiToClose bool
Gets or sets a value indicating whether to wait for the Gui window to close before returning from the execution method. Default value is true.
Inherited from GuiCommandBase<T>

Methods

Name Value Summary
AddArgument(string) void
Adds the specified argument to the AdditionalArguments collection, unless it is already present.
Inherited from CommandBase<T>
After(int, string, string) void
This method is called after the command has been executed. You can use this to clean up after the command execution (like removing temporary files), and to react to the exit code from the command line client. If the exit code is considered a failure, this method should throw the correct exception.
Inherited from CommandBase<T>
Before() void
This method is called before the command is executed. You can use this to store temporary files (like a commit message or similar) that the Arguments refer to, before the command is executed.
Inherited from CommandBase<T>
Cleanup() void
Override this method to implement code that will execute after command line execution.
EnsureCommandAvailability() void
This method will throw an System.InvalidOperationException if the command is not available in the installed client.
Inherited from GuiCommandBase<T>
static
EnsurePropertyAvailability(string, GuiClientType) void
This method will throw a System.InvalidOperationException if the "wrong" client type is installed, to signal that a given property on a command object can only be used from a specific client type.
Inherited from GuiCommandBase<T>
static
ParseStandardOutputForResults(int, string) void
This method should parse and store the appropriate execution result output according to the type of data the command line client would return for the command.
Inherited from CommandBase<T>
Prepare() void
Override this method to implement code that will execute before command line execution.
Inherited from CommandBase<T>
ThrowOnUnsuccessfulExecution(int, string) void
This method should throw the appropriate exception depending on the contents of the exitCode and standardErrorOutput parameters, or simply return if the execution is considered successful.
Inherited from CommandBase<T>
Validate() void
Validates the command configuration. This method should throw the necessary exceptions to signal missing or incorrect configuration (like attempting to add files to the repository without specifying which files to add.)
Inherited from GuiCommandBase<T>
WithAdditionalArgument(string) T
Adds the value to the AdditionalArguments collection property and returns this instance.
Inherited from CommandBase<T>
WithFiles(string[]) T
Adds all the values to the Files collection property and returns this command instance.
WithObserver(IMercurialCommandObserver) T
Sets the Observer property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithShowClean(bool) StatusGuiCommand
Sets the ShowClean property to the specified value and returns this StatusGuiCommand instance.
WithShowIgnored(bool) StatusGuiCommand
Sets the ShowIgnored property to the specified value and returns this StatusGuiCommand instance.
WithTimeout(int) T
Sets the Timeout property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithWaitForGuiToClose(bool) T
Sets the WaitForGuiToClose property to the specified value and returns this command instance.
Inherited from GuiCommandBase<T>

Extension Methods

Name Value Summary
OperateOnPatchRepository<StatusGuiCommand>() T
Makes the command operate on the patch repository instead of the main repository.