Class AstXmlTaskNode
The XML Task retrieves XML data, performs specified operations, and saves the updated documents to specified files or variables.
Namespace: Varigence.Languages.Biml.Task
Assembly: Biml.dll
public class AstXmlTaskNode : AstTaskBaseNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable, IDataflowItem
- Inheritance
Implements
IBindableItem, Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, IValidationInfo, System.ComponentModel.IDataErrorInfo, INamedItem, Varigence.Utility.Collections.IScopedNameIndexable, IDataflowItem,
Constructors
| Name | Description |
|---|---|
| AstXmlTaskNode(IFrameworkItem) | Initializes a new instance of the AstXmlTaskNode class with the specified parent node. |
Properties
| Name | Description |
|---|---|
| Destination | This value specifies the connection or varible to which results are saved. |
| DiffAlgorithm | This value specifies which comparison algorithm is used to compare documents. |
| DiffAlgorithmDefaultValue | Gets the default value for the DiffAlgorithm property |
| DiffGramDestination | This value specifies the location to which comparison results are saved. |
| DiffOptions | This is value is a collection of flags for options used to compare documents |
| DiffOptionsDefaultValue | Gets the default value for the DiffOptions property |
| FailOnDifference | This value specifies whether the task fails if the XML document is not valid according to the validation schema. |
| FailOnDifferenceDefaultValue | Gets the default value for the FailOnDifference property |
| FailOnValidationFail | This value specifies whether the task fails if a validation fails. |
| FailOnValidationFailDefaultValue | Gets the default value for the FailOnValidationFail property |
| FriendlyTypeName | Gets the friendly name of the type of this node |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| MergeXPathSource | This value specifies the merge location in the source document. |
| OperationType | This value specifies the type of the operation to perform. |
| OperationTypeDefaultValue | Gets the default value for the OperationType property |
| OverwriteDestination | This value specifies whether the operation is allowed to overwrite existing destination files. |
| OverwriteDestinationDefaultValue | Gets the default value for the OverwriteDestination property |
| PutResultInOneNode | This value specifies whether operation results are placed in one node. |
| PutResultInOneNodeDefaultValue | Gets the default value for the PutResultInOneNode property |
| SaveOperationResult | This value specifies whether the Diff operation output is saved. |
| SaveOperationResultDefaultValue | Gets the default value for the SaveOperationResult property |
| SecondOperand | This value specifies the connection, variable, or user-provided text that serves as the second operand in a two-operand operation. |
| Source | This value specifies the source that the operation uses. This can be a connection, a variable or user-supplied text. |
| StaticUserDefinedItems | Specifies a collection of items that are common across all instances of the same type in the framework. |
| ValidationType | This value specifies the validation type used by the operation. |
| ValidationTypeDefaultValue | Gets the default value for the ValidationType property |
| XPathOperation | This value specifies the Xpath operation to be performed. |
| XPathOperationDefaultValue | Gets the default value for the XPathOperation property |
Methods
| Name | Description |
|---|---|
| BindingScopeBoundaries() | Retrieves the permitted scope boundaries to bind references from this node. |
| CopyFrom(IFrameworkItem, UnboundReferences) | Instructs the node to copy property values from the supplied node into itself. This method should only be used by the internal Biml framework. |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| Duplicate() | Creates a duplicate of the current node |
| Duplicate(Dictionary<IFrameworkItem, IFrameworkItem>) | Creates a duplicate of the current node with the scoped node mapping |
| Duplicate(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| Duplicate(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>) | Creates a duplicate of the current node with the specified parent item and scoped node mapping |
| DuplicateHusk(IFrameworkItem) | Creates an empty object into which the values from the current node will be duplicated. This method should only be used by the internal Biml framework |
| DuplicateInto(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>) | Copies the values from the current node into a husk object with the specified scoped node mapping. This method should only be used by the internal Biml framework |
| EmitXmlForAction(AstEnginePropertyAction) | Instructs the node to make changes to its underlying Biml code that correspond to the provided action. This method should only be used by the internal Biml framework. |
| EmitXmlForProperty(String, Int32) | Instructs the node to make changes to its underlying Biml code that correspond to the provided property and index. This method should only be used by the internal Biml framework. |
| GetAllItemsReferencedByDefinedSuccessors() | Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem. |
| GetBimlAttributeFragment(CulturedStringBuilder) | |
| GetBimlChildFragment(CulturedStringBuilder, Int32) | |
| GetBimlFragment(CulturedStringBuilder, Int32, Boolean) | Internal method used by the Biml engine to produce the XML code for the current object. |
| GetDefaultValue(String) | Retrieves the default value for the property with the name propertyName |
| GetDefaultValue<T>(String) | Retrieves the default value for the property with the name propertyName |
| GetJson(StringBuilder, ref Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetPotentialParentProperties() | Retrieves the reflection information for related properties of this node type. |
| GetPropertyValue(String) | Retrieves the current value for the property with the name propertyName |
| GetReflectionInfoFromXmlParsePath(String) | Retrieves the reflection information corresponding to the Xml parse path beginning at this node. |
| HasAnyBimlChildNodes() | |
| MergeFrom(IFrameworkItem, UnboundReferences, Boolean) | Instructs the node to merge property values from the supplied node into itself. This method should only be used by the internal Biml framework. |
| NotifyCollectionPropertyChanged(Object, String, NotifyCollectionChangedEventArgs) | Internal Biml framework method used to notify this node that the specified collection property value has changed. |
| ParseAttribute(XAttribute, ParserContext) | |
| ParseChild(XElement, ParserContext) | |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| Validate(ValidationReporter) | Retrieves a collection of validation and diagnostic messages for the current node. |