Summary

Implements the TortoiseHg "tag" command: Open the tag tool.

Assembly

Mercurial.Net.dll

Namespace

Interfaces

Base Types

graph TD Base0["GuiCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial.Gui/GuiCommandBase_1" Base1["CommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial/CommandBase_1" Base2["object"]-->Base1 Interface0["IGuiCommand"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial.Gui/IGuiCommand" Interface1["ICommand"]-.->Type click Interface1 "/Cake.Hg/api/Mercurial/ICommand" Type["TagGuiCommand"] class Type type-node

Syntax

public sealed class TagGuiCommand : GuiCommandBase<TagGuiCommand>, IGuiCommand, ICommand

Constructors

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

Properties

Name	Value	Summary
Action	TagAction	Gets or sets a value indicating whether to add or remove the tag. Default is `Add`.
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. Inherited from CommandBase<T>
Command	string	Gets the command to execute with the Mercurial command line client. Inherited from CommandBase<T>
CommitMessage	string	Gets or sets the commit message to use, or leave blank to use a generated one. Default is `System.String.Empty`.
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>
IsAvailable	bool	Gets a value indicating whether the given command is available. Inherited from GuiCommandBase<T> static
IsLocal	bool	Gets or sets a value indicating whether to add or remove a local tag. If `false`, a changeset will be committed that edits the .hgtags file accordingly. Default is `false`.
Name	string	Gets or sets the name of the tag to add or remove.
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>
ReplaceExisting	bool	Gets or sets a value indicating whether to replace an existing tag, in effect moving the tag to a different changeset. Default is `false`.
Revision	RevSpec	Gets or sets which revision to tag, or `null` for the parent of the working folder. Default is `null`.
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. Inherited from CommandBase<T>
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>
WithAction(TagAction)	TagGuiCommand	Sets the `Action` property to the specified value and returns this `TagGuiCommand` instance.
WithAdditionalArgument(string)	T	Adds the value to the `AdditionalArguments` collection property and returns this instance. Inherited from CommandBase<T>
WithCommitMessage(string)	TagGuiCommand	Sets the `CommitMessage` property to the specified value and returns this `TagGuiCommand` instance.
WithIsLocal(bool)	TagGuiCommand	Sets the `IsLocal` property to the specified value and returns this `TagGuiCommand` instance.
WithName(string)	TagGuiCommand	Sets the `Name` property to the specified value and returns this `TagGuiCommand` instance.
WithObserver(IMercurialCommandObserver)	T	Sets the `Observer` property to the specified value and returns this instance. Inherited from CommandBase<T>
WithReplaceExisting(bool)	TagGuiCommand	Sets the `ReplaceExisting` property to the specified value and returns this `TagGuiCommand` instance.
WithRevision(RevSpec)	TagGuiCommand	Sets the `Revision` property to the specified value and returns this `TagGuiCommand` 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