RenameCommand Class

Summary

Show Rename about supported formats (Command: rn).

The builder is RenameCommandBuilder.

graph BT Type-->Base0["Object"] Type-.->Interface0["ICommand"] click Interface0 "/api/Cake.SevenZip.Commands/ICommand" Type-.->Interface1["IHaveArgumentArchive"] click Interface1 "/api/Cake.SevenZip.Arguments/IHaveArgumentArchive" Type-.->Interface2["IHaveArgument"] click Interface2 "/api/Cake.SevenZip.Arguments/IHaveArgument" Type-.->Interface3["ISupportSwitchIncludeFilenames"] click Interface3 "/api/Cake.SevenZip.Switches/ISupportSwitchIncludeFilenames" Type-.->Interface4["ISupportSwitchCompressionMethod"] click Interface4 "/api/Cake.SevenZip.Switches/ISupportSwitchCompressionMethod" Type-.->Interface5["ISupportSwitchPassword"] click Interface5 "/api/Cake.SevenZip.Switches/ISupportSwitchPassword" Type-.->Interface6["ISupportSwitchRecurseSubdirectories"] click Interface6 "/api/Cake.SevenZip.Switches/ISupportSwitchRecurseSubdirectories" Type-.->Interface7["ISupportSwitchTimestampFromMostRecentFile"] click Interface7 "/api/Cake.SevenZip.Switches/ISupportSwitchTimestampFromMostRecentFile" Type-.->Interface8["ISupportSwitchUpdateOptions"] click Interface8 "/api/Cake.SevenZip.Switches/ISupportSwitchUpdateOptions" Type-.->Interface9["ISupportSwitchWorkingDirectory"] click Interface9 "/api/Cake.SevenZip.Switches/ISupportSwitchWorkingDirectory" Type-.->Interface10["ISupportSwitchExcludeFilenames"] click Interface10 "/api/Cake.SevenZip.Switches/ISupportSwitchExcludeFilenames" Type-.->Interface11["ISupportSwitch"] click Interface11 "/api/Cake.SevenZip.Switches/ISupportSwitch" Type["RenameCommand"] class Type type-node

Syntax

public sealed class RenameCommand : ICommand, IHaveArgumentArchive, IHaveArgument, 
    ISupportSwitchIncludeFilenames, ISupportSwitchCompressionMethod, ISupportSwitchPassword, 
    ISupportSwitchRecurseSubdirectories, ISupportSwitchTimestampFromMostRecentFile, 
    ISupportSwitchUpdateOptions, ISupportSwitchWorkingDirectory, ISupportSwitchExcludeFilenames, 
    ISupportSwitch

Constructors

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

Properties

Name Value Summary
Archive FilePath
Sets the archive the command operates on.
CompressionMethod SwitchCompressionMethod
Gets or sets the compression method.
ExcludeFilenames SwitchExcludeFilenameCollection
Gets or sets the SwitchExcludeFilenameCollection.
IncludeFilenames SwitchIncludeFilenameCollection
Gets or sets the SwitchIncludeFilenameCollection.
Password SwitchPassword
Gets or sets the SwitchPassword.
RecurseSubdirectories SwitchRecurseSubdirectories
Gets or sets the SwitchRecurseSubdirectories.
RenamePairs ICollection<RenamePair>
Gets the files to be renamed.
TimestampFromMostRecentFile SwitchSetTimestampFromMostRecentFile
Gets or sets the SwitchSetTimestampFromMostRecentFile.
UpdateOptions SwitchUpdateOptions
Gets or sets the SwitchUpdateOptions.
WorkingDirectory SwitchWorkingDirectory
Gets or sets the SwitchWorkingDirectory.

Methods

Name Value Summary
BuildArguments(ProcessArgumentBuilder) void
Builds the arguments. Used internally.

Extension Methods

Name Value Summary
Dump<RenameCommand>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<RenameCommand>(RenameCommand[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<RenameCommand>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<RenameCommand>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<RenameCommand>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<RenameCommand>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin