Summary

Paths are groups of files and/or directories that need to be passed as a single unit. The order in which parts of the path are specified in the build file is retained, and duplicate parts are automatically suppressed.

Assembly

NAnt.Core.dll

Namespace

NAnt.Core.Types

Base Types

graph BT Type-->Base0["DataTypeBase"] click Base0 "/api/NAnt.Core/DataTypeBase" Base0-->Base1["Element"] click Base1 "/api/NAnt.Core/Element" Base1-->Base2["Object"] Type["PathSet"] class Type type-node

Syntax

[Serializable()]
[ElementName("path")]
public class PathSet : DataTypeBase

Examples

Define a global <path> that can be referenced by other tasks or types.

<path id="includes-path">
        <pathelement path="%INCLUDE%" />
        <pathelement dir="${build.dir}/include" />
    </path>

Attributes

Type	Description
SerializableAttribute
ElementNameAttribute	Indicates that class should be treated as a NAnt element.

Constructors

Name	Summary
PathSet()	Initializes a new instance of the `NAnt.Core.Types.PathSet` class.
PathSet(Project, string)	Invoked by `NAnt.Core.Element.AttributeConfigurator` for build attributes with an underlying `NAnt.Core.Types.PathSet` type.

Properties

Name	Value	Summary
CanBeReferenced	bool	Gets a value indicating whether a reference to the type can be defined. Inherited from DataTypeBase
CustomXmlProcessing	bool	Gets a value indicating whether the element is performing additional processing using the `NAnt.Core.Element.XmlNode` that was used to initialize the element. Inherited from Element
ID	string	The ID used to be referenced later. Inherited from DataTypeBase
Location	Location	Gets or sets the location in the build file where the element is defined. Inherited from Element
Name	string	Gets the name of the data type. Inherited from DataTypeBase
NamespaceManager	XmlNamespaceManager	Gets or sets the `System.Xml.XmlNamespaceManager`. Inherited from Element
Parent	Object	Gets or sets the parent of the element. Inherited from Element
Project	Project	Gets or sets the `NAnt.Core.Element.Project` to which this element belongs. Inherited from Element
Properties	PropertyDictionary	Gets the properties local to this `NAnt.Core.Element` and the `NAnt.Core.Element.Project`. Inherited from Element
RefID	string	The ID to use as the reference. Inherited from DataTypeBase
XmlNode	XmlNode	Gets or sets the XML node of the element. Inherited from Element

Methods

Name	Value	Summary
AddPath(PathSet)	void	Defines a set of path elements to add to the current path.
AddPathElement(PathElement)	void	Defines a path element to add to the current path.
CopyTo(DataTypeBase)	void	Copies all instance data of the `NAnt.Core.DataTypeBase` to a given `NAnt.Core.DataTypeBase`. Inherited from DataTypeBase
CopyTo(Element)	void	Copies all instance data of the `NAnt.Core.Element` to a given `NAnt.Core.Element`. Inherited from Element
GetAttributeConfigurationNode(FrameworkInfo, string)	XmlNode	Locates the XML node for the specified attribute in the project configuration node. Inherited from Element
GetAttributeConfigurationNode(XmlNode, FrameworkInfo, string)	XmlNode	Inherited from Element
GetElements()	StringCollection	Returns all path elements defined by this path object.
GetLocation()	Location	Retrieves the location in the build file where the element is defined. Inherited from Element
Initialize()	void	Derived classes should override to this method to provide extra initialization and validation not covered by the base class. Inherited from DataTypeBase
Initialize(XmlNode)	void	Performs default initialization. Inherited from Element
InitializeBuildElement(Element, XmlNode, Element, Type)	Element	Initializes the build element. Inherited from Element static
InitializeElement(XmlNode)	void	Derived classes should override to this method to provide extra initialization and validation not covered by the base class. Inherited from Element
InitializeXml(XmlNode, PropertyDictionary, FrameworkInfo)	void	Initializes all build attributes and child elements. Inherited from Element
Log(Level, string)	void	Logs a message with the given priority. Inherited from Element
Log(Level, string, Object[])	void	Logs a message with the given priority. Inherited from Element
Reset()	void	Should be overridden by derived classes. clones the referenced types data into the current instance. Inherited from DataTypeBase
ToString()	string	Returns a textual representation of the path, which can be used as PATH environment variable definition.
TranslatePath(Project, string)	StringCollection	Splits a PATH (with ; or : as separators) into its parts, while resolving references to environment variables. static