Asposecpplib
System::Xml::Xsl::XslCompiledTransform Class Referencefinal

Transforms XML data using an XSLT style sheet. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Public Types

typedef SharedPtr< XslCompiledTransformPtr
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 XslCompiledTransform ()
 Constructs a new instance of XslCompiledTransform class. More...
 
virtual ~XslCompiledTransform ()
 Destructor. More...
 
void Load (const String &uri)
 Compiles an XSLT style sheet located at the specified URI. More...
 
void Load (const SharedPtr< XPath::IXPathNavigable > &stylesheet)
 Compiles an XSLT style sheet contained in the specified IXPathNavigatible object. More...
 
void Load (const XmlReader::Ptr &stylesheet)
 Compiles an XSLT style sheet contained in the specified XmlReader object. More...
 
void Transform (const String &inputUri, const String &outputfile)
 Performs the transform using the specifed input document and outputs the results to a file. More...
 
void Transform (const String &inputUri, const XsltArgumentList::Ptr &arguments, const SharedPtr< System::IO::Stream > &result_stream)
 Performs the transform using the specifed input document and outputs the results to the specified stream. More...
 
void Transform (const String &inputUri, const XsltArgumentList::Ptr &arguments, const SharedPtr< System::IO::TextWriter > &result_writer)
 Performs the transform using the specifed input document and outputs the results to the specified TextWriter. More...
 
void Transform (const String &inputUri, const XsltArgumentList::Ptr &arguments, const SharedPtr< System::Xml::XmlWriter > &result_writer)
 Performs the transform using the specifed input document and outputs the results to the specified XmlWriter. More...
 
void Transform (const SharedPtr< XmlReader > &input, const SharedPtr< XmlWriter > &results)
 Performs the transform using the input data from the specified stream and outputs the results to the specified XmlWriter. More...
 
void Transform (const SharedPtr< XmlReader > &input, const XsltArgumentList::Ptr &arguments, const SharedPtr< XmlWriter > &results)
 Performs the transform using the input data from the specified stream and outputs the results to the specified XmlWriter. More...
 
void Transform (const SharedPtr< XPath::IXPathNavigable > &input, const XsltArgumentList::Ptr &arguments, const SharedPtr< System::IO::Stream > &results)
 Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified stream. More...
 
void Transform (const SharedPtr< XPath::IXPathNavigable > &input, const XsltArgumentList::Ptr &arguments, const SharedPtr< System::IO::TextWriter > &results)
 Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified TextWriter. More...
 
void Transform (const SharedPtr< XPath::IXPathNavigable > &input, const SharedPtr< XmlWriter > &results)
 Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified XmlWriter. More...
 
void Transform (const SharedPtr< XPath::IXPathNavigable > &input, const XsltArgumentList::Ptr &arguments, const SharedPtr< XmlWriter > &results)
 Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified XmlWriter. More...
 
void Transform (const SharedPtr< XPath::IXPathNavigable > &input, const XsltArgumentList::Ptr &arguments, const SharedPtr< XmlWriter > &results, const SharedPtr< XmlResolver > &documentResolver)
 Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified XmlWriter. More...
 
SharedPtr< XmlWriterSettingsget_OutputSettings ()
 Gets an XmlWriterSettings object that contains the output information derived from the xsl:output element of the style sheet. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Transforms XML data using an XSLT style sheet. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ XslCompiledTransform()

System::Xml::Xsl::XslCompiledTransform::XslCompiledTransform ( )

Constructs a new instance of XslCompiledTransform class.

◆ ~XslCompiledTransform()

virtual System::Xml::Xsl::XslCompiledTransform::~XslCompiledTransform ( )
virtual

Destructor.

Member Function Documentation

◆ get_OutputSettings()

SharedPtr<XmlWriterSettings> System::Xml::Xsl::XslCompiledTransform::get_OutputSettings ( )

Gets an XmlWriterSettings object that contains the output information derived from the xsl:output element of the style sheet.

◆ Load() [1/3]

void System::Xml::Xsl::XslCompiledTransform::Load ( const SharedPtr< XPath::IXPathNavigable > &  stylesheet)

Compiles an XSLT style sheet contained in the specified IXPathNavigatible object.

Parameters
stylesheetThe IXPathNavigatible object that contains the style sheet

◆ Load() [2/3]

void System::Xml::Xsl::XslCompiledTransform::Load ( const String uri)

Compiles an XSLT style sheet located at the specified URI.

Parameters
uriThe URI at which the style sheet is located

◆ Load() [3/3]

void System::Xml::Xsl::XslCompiledTransform::Load ( const XmlReader::Ptr stylesheet)

Compiles an XSLT style sheet contained in the specified XmlReader object.

Parameters
stylesheetThe XmlReader object that contains the style sheet

◆ Transform() [1/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XmlReader > &  input,
const SharedPtr< XmlWriter > &  results 
)

Performs the transform using the input data from the specified stream and outputs the results to the specified XmlWriter.

Parameters
inputThe stream providing the input data
resultsAn xmlWriter object to which the output is written

◆ Transform() [2/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XmlReader > &  input,
const XsltArgumentList::Ptr arguments,
const SharedPtr< XmlWriter > &  results 
)

Performs the transform using the input data from the specified stream and outputs the results to the specified XmlWriter.

Parameters
inputThe stream providing the input data
argumentsAdditional run-time arguments
resultsAn xmlWriter object to which the output is written

◆ Transform() [3/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XPath::IXPathNavigable > &  input,
const SharedPtr< XmlWriter > &  results 
)

Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified XmlWriter.

Parameters
inputThe IXPathNavigatible object that contains the input document
resultsAn XmlWriter object to which the output is written

◆ Transform() [4/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XPath::IXPathNavigable > &  input,
const XsltArgumentList::Ptr arguments,
const SharedPtr< System::IO::Stream > &  results 
)

Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified stream.

Parameters
inputThe IXPathNavigatible object that contains the input document
argumentsAdditional run-time arguments
resultsA stream to which the output is written

◆ Transform() [5/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XPath::IXPathNavigable > &  input,
const XsltArgumentList::Ptr arguments,
const SharedPtr< System::IO::TextWriter > &  results 
)

Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified TextWriter.

Parameters
inputThe IXPathNavigatible object that contains the input document
argumentsAdditional run-time arguments
resultsA TextWriter object to which the output is written

◆ Transform() [6/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XPath::IXPathNavigable > &  input,
const XsltArgumentList::Ptr arguments,
const SharedPtr< XmlWriter > &  results 
)

Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified XmlWriter.

Parameters
inputThe IXPathNavigatible object that contains the input document
argumentsAdditional run-time arguments
resultsAn XmlWriter object to which the output is written

◆ Transform() [7/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const SharedPtr< XPath::IXPathNavigable > &  input,
const XsltArgumentList::Ptr arguments,
const SharedPtr< XmlWriter > &  results,
const SharedPtr< XmlResolver > &  documentResolver 
)

Performs the transform using the input document from the IXPathNavigatible object and outputs the results to the specified XmlWriter.

Parameters
inputThe IXPathNavigatible object that contains the input document
argumentsAdditional run-time arguments
resultsAn XmlWriter object to which the output is written
documentResolverThe XmlResolver object used to resolve the Xslt document() function

◆ Transform() [8/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const String inputUri,
const String outputfile 
)

Performs the transform using the specifed input document and outputs the results to a file.

Parameters
inputUriThe URI at which the input document is located
outputfileA file to which the output is written

◆ Transform() [9/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const String inputUri,
const XsltArgumentList::Ptr arguments,
const SharedPtr< System::IO::Stream > &  result_stream 
)

Performs the transform using the specifed input document and outputs the results to the specified stream.

Parameters
inputUriThe URI at which the input document is located
argumentsAdditional run-time arguments
result_streamA stream to which the output is written

◆ Transform() [10/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const String inputUri,
const XsltArgumentList::Ptr arguments,
const SharedPtr< System::IO::TextWriter > &  result_writer 
)

Performs the transform using the specifed input document and outputs the results to the specified TextWriter.

Parameters
inputUriThe URI at which the input document is located
argumentsAdditional run-time arguments
result_writerA TextWriter object to which the output is written

◆ Transform() [11/11]

void System::Xml::Xsl::XslCompiledTransform::Transform ( const String inputUri,
const XsltArgumentList::Ptr arguments,
const SharedPtr< System::Xml::XmlWriter > &  result_writer 
)

Performs the transform using the specifed input document and outputs the results to the specified XmlWriter.

Parameters
inputUriThe URI at which the input document is located
argumentsAdditional run-time arguments
result_writerAn xmlWriter object to which the output is written