XmlTask Class

MSBuild Extension Pack

previous page next page
XmlTask Class MSBuild Extension Pack Help 4.0.12.0
Valid TaskActions are:

Transform (Required: Xml or XmlFile, XslTransform or XslTransformFile Optional: Conformance, Indent, OmitXmlDeclaration, OutputFile, TextEncoding Output: Output)

Validate (Required: Xml or XmlFile, SchemaFiles Optional: TargetNamespace Output: IsValid, Output)

Remote Execution Support: NA

Inheritance Hierarchy
SystemObject  Microsoft.Build.UtilitiesTask
    MSBuild.ExtensionPackBaseTask
      MSBuild.ExtensionPack.XmlXmlTask

Namespace: MSBuild.ExtensionPack.Xml
Assembly: MSBuild.ExtensionPack (in MSBuild.ExtensionPack.dll) Version: 4.0.0.0

The XmlTask type exposes the following members.

Constructors
  NameDescription
Public methodXmlTask
Top
Properties
  NameDescription
Public propertyConformance
Sets the ConformanceLevel. Supports Auto, Document and Fragment. Default is ConformanceLevel.Document
Public propertyIndent
Set the Indent option for TransForm. Default is False
Public propertyIsValid
Gets whether an XmlFile is valid xml
Public propertyOmitXmlDeclaration
Set the OmitXmlDeclaration option for TransForm. Default is False
Public propertyOutput
Get the Output
Public propertyOutputFile
Sets the OutputFile
Public propertySchemaFiles
Sets the Schema Files collection
Public propertyTargetNamespace
Sets the TargetNamespace for Validate. Default is ""
Public propertyTextEncoding
Set the Encoding option for TransForm. Default is UTF8
Public propertyXml
Sets the XmlFile
Public propertyXmlFile
Sets the XmlFile
Public propertyXslTransform
Sets the XslTransformFile
Public propertyXslTransformFile
Sets the XslTransformFile
Top
Examples
Copy
<Project ToolsVersion="4.0" DefaultTargets="Default" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <TPath>$(MSBuildProjectDirectory)\..\MSBuild.ExtensionPack.tasks</TPath>
        <TPath Condition="Exists('$(MSBuildProjectDirectory)\..\..\Common\MSBuild.ExtensionPack.tasks')">$(MSBuildProjectDirectory)\..\..\Common\MSBuild.ExtensionPack.tasks</TPath>
    </PropertyGroup>
    <Import Project="$(TPath)"/>
    <Target Name="Default">
        <ItemGroup>
            <Schema Include="c:\Demo1\demo.xsd"/>
        </ItemGroup>
        <PropertyGroup>
            <MyXml>
                &lt;![CDATA[
                <Parent>
                    <Child1>Child1 data</Child1>
                    <Child2>Child2 data</Child2>
                </Parent>]]&gt;
            </MyXml>
            <MyXsl>
                &lt;![CDATA[<?xml version='1.0'?>
                <xsl:stylesheet xmlns:xsl='http://www.w3.org/1999/XSL/Transform' version='1.0'>
                    <xsl:template match='/Parent'>
                        <Root>
                            <C1>
                                <xsl:value-of select='Child1'/>
                            </C1>
                            <C2>
                                <xsl:value-of select='Child2'/>
                            </C2>
                        </Root>
                    </xsl:template>
                </xsl:stylesheet>]]&gt;
            </MyXsl>
            <MyValidXml>
                &lt;![CDATA[
                <D>
                    <Name full="Mike" type="3f3">
                        <Place>aPlace</Place>
                    </Name>
                </D>]]&gt;
            </MyValidXml>
        </PropertyGroup>
        <!-- Validate an XmlFile -->
        <MSBuild.ExtensionPack.Xml.XmlTask TaskAction="Validate" XmlFile="c:\Demo1\demo.xml" SchemaFiles="@(Schema)">
            <Output PropertyName="Validated" TaskParameter="IsValid"/>
            <Output PropertyName="Out" TaskParameter="Output"/>
        </MSBuild.ExtensionPack.Xml.XmlTask>
        <Message Text="Valid File: $(Validated)"/>
        <Message Text="Output: $(Out)"/>
        <!-- Validate a piece of Xml -->
        <MSBuild.ExtensionPack.Xml.XmlTask TaskAction="Validate" Xml="$(MyValidXml)" SchemaFiles="@(Schema)">
            <Output PropertyName="Validated" TaskParameter="IsValid"/>
        </MSBuild.ExtensionPack.Xml.XmlTask>
        <Message Text="Valid File: $(Validated)"/>
        <!-- Transform an Xml file with an Xslt file -->
        <MSBuild.ExtensionPack.Xml.XmlTask TaskAction="Transform" XmlFile="C:\Demo1\XmlForTransform.xml" XslTransformFile="C:\Demo1\Transform.xslt">
            <Output PropertyName="Out" TaskParameter="Output"/>
        </MSBuild.ExtensionPack.Xml.XmlTask>
        <Message Text="Transformed Xml: $(Out)"/>
        <!-- Transfrom a piece of Xml with an Xslt file -->
        <MSBuild.ExtensionPack.Xml.XmlTask TaskAction="Transform" Xml="$(MyXml)" XslTransformFile="C:\Demo1\Transform.xslt">
            <Output PropertyName="Out" TaskParameter="Output"/>
        </MSBuild.ExtensionPack.Xml.XmlTask>
        <Message Text="Transformed Xml: $(Out)"/>
        <!-- Transfrom a piece of Xml with a piece of Xslt and write it out to a file with indented formatting -->
        <MSBuild.ExtensionPack.Xml.XmlTask TaskAction="Transform" Xml="$(MyXml)" XslTransform="$(MyXsl)" OutputFile="C:\newxml.xml" Indent="true">
            <Output PropertyName="Out" TaskParameter="Output"/>
        </MSBuild.ExtensionPack.Xml.XmlTask>
        <Message Text="Transformed Xml: $(Out)"/>
    </Target>
</Project>
See Also

Reference

MSBuild.ExtensionPack.Xml Namespace
previous page start next page