NAnt SDK Documentation - v0.92

ZipTask Members

ZipTask overview

Public Instance Constructors

ZipTask Constructor Initializes a new instance of the ZipTask class.

Public Instance Properties

Comment The comment for the file.
DuplicateHandling Specifies the behaviour when a duplicate file is found. The default is Add.
Encoding The character encoding to use for filenames and comment inside the zip file. The default is the system's OEM code page.
FailOnError (inherited from Task) Determines if task failure stops the build, or is just reported. The default is true.
Flatten Ignore directory structure of source directory, compress all files into a single directory. The default value is false.
IfDefined (inherited from Task) If true then the task will be executed; otherwise, skipped. The default is true.
IncludeEmptyDirs Include empty directories in the generated zip file. The default is false.
LogPrefix (inherited from Task)Obsolete. The prefix used when sending messages to the log.
Name (inherited from Task) The name of the task.
NamespaceManager (inherited from Element) Gets or sets the XmlNamespaceManager.
Parent (inherited from Element) Gets or sets the parent of the element.
Project (inherited from Element) Gets or sets the Project to which this element belongs.
Properties (inherited from Element) Gets the properties local to this Element and the Project.
Stamp Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS.
Threshold (inherited from Task) Gets or sets the log threshold for this Task. By default the threshold of a task is Debug, causing no messages to be filtered in the task itself.
UnlessDefined (inherited from Task) Opposite of IfDefined. If false then the task will be executed; otherwise, skipped. The default is false.
Verbose (inherited from Task) Determines whether the task should report detailed build log messages. The default is false.
ZipFile The zip file to create.
ZipFileSets The set of files to be included in the archive.
ZipLevel Desired level of compression. Possible values are 0 (STORE only) to 9 (highest). The default is 6.

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Execute (inherited from Task) Executes the task unless it is skipped.
GetHashCode (inherited from Object) Serves as a hash function for a particular type.
GetLocation (inherited from Element) Retrieves the location in the build file where the element is defined.
GetType (inherited from Object) Gets the Type of the current instance.
Initialize (inherited from Element)Overloaded. Performs default initialization.
InitializeTaskConfiguration (inherited from Task) Initializes the configuration of the task using configuration settings retrieved from the NAnt configuration file.
IsLogEnabledFor (inherited from Task) Determines whether build output is enabled for the given Level.
Log (inherited from Task)Overloaded. Logs a message with the given priority.
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Properties

CustomXmlProcessing (inherited from Element) Gets a value indicating whether the element is performing additional processing using the XmlNode that was used to initialize the element.
Location (inherited from Element) Gets or sets the location in the build file where the element is defined.
XmlNode (inherited from Element) Gets or sets the XML node of the element.

Protected Instance Methods

CopyTo (inherited from Element) Copies all instance data of the Element to a given Element.
ExecuteTask Creates the zip file.
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetAttributeConfigurationNode (inherited from Task)Overloaded. Locates the XML node for the specified attribute in either the configuration section of the extension assembly or the.project.
GetAttributeConfigurationNode (inherited from Element)Overloaded. Locates the XML node for the specified attribute in the project configuration node.
Initialize (inherited from Task)Overloaded. Initializes the task.
InitializeElement (inherited from Element)Obsolete. Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
InitializeTask (inherited from Task)Obsolete. Initializes the task.
InitializeXml (inherited from Element) Initializes all build attributes and child elements.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

ZipTask Class | NAnt.Compression.Tasks Namespace