Summary
Represents an option.
- Assembly
- NAnt
.Core .dll - Namespace
- NAnt
.Core .Types - Interfaces
- Base Types
-
- Object
- Element
graph BT
Type-->Base0["Element"]
click Base0 "/api/NAnt.Core/Element"
Base0-->Base1["Object"]
Type-.->Interface0["IConditional"]
click Interface0 "/api/NAnt.Core/IConditional"
Type["Option"]
class Type type-node
Syntax
[ElementName("option")]
public class Option : Element, IConditional
Attributes
| Type | Description |
|---|---|
| ElementNameAttribute | Indicates that class should be treated as a NAnt element. |
Constructors
| Name | Summary |
|---|---|
| Option |
Default constructor |
| Option |
name, value constructor |
Properties
| Name | Value | Summary |
|---|---|---|
| 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
|
| IfDefined | bool |
Indicates if the option should be passed to the task.
If
true then the option will be passed;
otherwise, skipped. The default is true.
|
| 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 XML element used to initialize this element.
Inherited from Element
|
| NamespaceManager | XmlNamespaceManager |
Gets or sets the
System.Xml.XmlNamespaceManager.
Inherited from Element
|
| OptionName | string |
Name of the option.
|
| 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
|
| UnlessDefined | bool |
Indicates if the option should not be passed to the task.
If
false then the option will be passed;
otherwise, skipped. The default is false.
|
| Value | string |
Value of the option. The default is
null.
|
| XmlNode | XmlNode |
Gets or sets the XML node of the element.
Inherited from Element
|
Methods
| Name | Value | Summary |
|---|---|---|
| CopyTo |
void |
Copies all instance data of the
NAnt.Core.Element to a given
NAnt.Core.Element.
Inherited from Element
|
| Get |
XmlNode |
Locates the XML node for the specified attribute in the project
configuration node.
Inherited from Element
|
| Get |
XmlNode |
Inherited from Element
|
| 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 Element
|
| Initialize |
void |
Performs default initialization.
Inherited from Element
|
| Initialize |
Element |
Initializes the build element.
Inherited from Element
static
|
| InitializeElement |
void |
Derived classes should override to this method to provide extra
initialization and validation not covered by the base class.
Inherited from Element
|
| InitializeXml |
void |
Initializes all build attributes and child elements.
Inherited from Element
|
| Log |
void |
Logs a message with the given priority.
Inherited from Element
|
| Log |
void |
Logs a message with the given priority.
Inherited from Element
|
