FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Common::Xsl::XslTransformer Class Reference

Inherits OSGeo::FDO::Runtime::Disposable.

Inheritance diagram for OSGeo::FDO::Common::Xsl::XslTransformer:

[legend]
List of all members.

Detailed Description

XslTransformer provides a way to execute an XSL stylesheet on an XML document.


Public Member Functions

__property OSGeo::FDO::Common::Xml::XmlReaderget_InDoc ()
 Gets the document being transformed.
__property OSGeo::FDO::Common::Io::IoTextWriterget_Log ()
 Gets the input logging object.
__property OSGeo::FDO::Common::Xml::XmlWriterget_OutDoc ()
 Gets the output document.
__property OSGeo::FDO::Common::DictionaryElementCollectionget_Parameters ()
 Gets the list of parameters that will be passed to the stylesheet by Transform(). The caller can add parameters to this list or modify/delete existing parameters. The parameter list is empty when this class is constructed. Parameter values must be in XPath syntax. Therefore, literal values must be enclosed in single quotes.
__property OSGeo::FDO::Common::Xml::XmlReaderget_Stylesheet ()
 Gets the XSL Stylesheet.
__property System::Void set_InDoc (OSGeo::FDO::Common::Xml::XmlReader *inDoc)
 Sets the document to transform.
__property System::Void set_Log (OSGeo::FDO::Common::Io::IoTextWriter *outDoc)
 Sets the input logging object.
__property System::Void set_OutDoc (OSGeo::FDO::Common::Xml::XmlWriter *outDoc)
 Sets the output document.
__property System::Void set_Stylesheet (OSGeo::FDO::Common::Xml::XmlReader *stylesheet)
 Sets the XSL stylesheet.
System::Void Transform ()
 Performs the transformation.
 XslTransformer (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs an XslTransformer based on an unmanaged instance of the object.
 XslTransformer (OSGeo::FDO::Common::Xml::XmlReader *inDoc, OSGeo::FDO::Common::Xml::XmlReader *stylesheet, OSGeo::FDO::Common::Xml::XmlWriter *outDoc, OSGeo::FDO::Common::Io::IoTextWriter *log)
 Constructs an XSL Transformer object.
 XslTransformer (OSGeo::FDO::Common::Xml::XmlReader *inDoc, OSGeo::FDO::Common::Xml::XmlReader *stylesheet, OSGeo::FDO::Common::Xml::XmlWriter *outDoc)
 Constructs an XSL Transformer object.
 XslTransformer (OSGeo::FDO::Common::Xml::XmlReader *inDoc, OSGeo::FDO::Common::Xml::XmlReader *stylesheet)
 Constructs an XSL Transformer object.
 XslTransformer (OSGeo::FDO::Common::Xml::XmlReader *inDoc)
 Constructs an XSL Transformer object.
 XslTransformer ()
 Constructs an XSL Transformer object.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()

Constructor & Destructor Documentation

OSGeo::FDO::Common::Xsl::XslTransformer::XslTransformer  ) 
 

Constructs an XSL Transformer object.

OSGeo::FDO::Common::Xsl::XslTransformer::XslTransformer OSGeo::FDO::Common::Xml::XmlReader inDoc  ) 
 

Constructs an XSL Transformer object.

Parameters:
inDoc Input the XML document to transform.

OSGeo::FDO::Common::Xsl::XslTransformer::XslTransformer OSGeo::FDO::Common::Xml::XmlReader inDoc,
OSGeo::FDO::Common::Xml::XmlReader stylesheet
 

Constructs an XSL Transformer object.

Parameters:
inDoc Input the XML document to transform.
stylesheet Input the XSL stylesheet with transformation instructions.

OSGeo::FDO::Common::Xsl::XslTransformer::XslTransformer OSGeo::FDO::Common::Xml::XmlReader inDoc,
OSGeo::FDO::Common::Xml::XmlReader stylesheet,
OSGeo::FDO::Common::Xml::XmlWriter outDoc
 

Constructs an XSL Transformer object.

Parameters:
inDoc Input the XML document to transform.
stylesheet Input the XSL stylesheet with transformation instructions.
outDoc Output the transformed XML document.
Note: The transformed document is not completely written until 'outDoc' and this transformer are destroyed by releasing all references to them. Therefore, these objects must be destroyed before reading back the transformed document.

OSGeo::FDO::Common::Xsl::XslTransformer::XslTransformer OSGeo::FDO::Common::Xml::XmlReader inDoc,
OSGeo::FDO::Common::Xml::XmlReader stylesheet,
OSGeo::FDO::Common::Xml::XmlWriter outDoc,
OSGeo::FDO::Common::Io::IoTextWriter log
 

Constructs an XSL Transformer object.

Parameters:
inDoc Input the XML document to transform.
stylesheet Input the XSL stylesheet with transformation instructions.
outDoc Output the transformed XML document.
Note: The transformed document is not completely written until 'outDoc' and this transformer are destroyed by releasing all references to them. Therefore, these objects must be destroyed before reading back the transformed document.
Parameters:
log Input the logging object.

OSGeo::FDO::Common::Xsl::XslTransformer::XslTransformer System::IntPtr  unmanaged,
System::Boolean  autoDelete
[inline]
 

Constructs an XslTransformer based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

__property OSGeo ::FDO ::Common ::Xml ::XmlReader* OSGeo::FDO::Common::Xsl::XslTransformer::get_InDoc  ) 
 

Gets the document being transformed.

Returns:
Returns the input document.

__property OSGeo ::FDO ::Common ::Io ::IoTextWriter* OSGeo::FDO::Common::Xsl::XslTransformer::get_Log  ) 
 

Gets the input logging object.

Returns:
Returns the input logging object

__property OSGeo ::FDO ::Common ::Xml ::XmlWriter* OSGeo::FDO::Common::Xsl::XslTransformer::get_OutDoc  ) 
 

Gets the output document.

Returns:
Returns the out document

__property OSGeo ::FDO ::Common ::DictionaryElementCollection* OSGeo::FDO::Common::Xsl::XslTransformer::get_Parameters  ) 
 

Gets the list of parameters that will be passed to the stylesheet by Transform(). The caller can add parameters to this list or modify/delete existing parameters. The parameter list is empty when this class is constructed. Parameter values must be in XPath syntax. Therefore, literal values must be enclosed in single quotes.

Returns:
Returns the parameter list.

__property OSGeo ::FDO ::Common ::Xml ::XmlReader* OSGeo::FDO::Common::Xsl::XslTransformer::get_Stylesheet  ) 
 

Gets the XSL Stylesheet.

Returns:
Returns the stylesheet.

System::Void OSGeo::FDO::Common::Xsl::XslTransformer::ReleaseUnmanagedObject  )  [protected, virtual]
 

Reimplemented from OSGeo::FDO::Runtime::Disposable.

__property System::Void OSGeo::FDO::Common::Xsl::XslTransformer::set_InDoc OSGeo::FDO::Common::Xml::XmlReader inDoc  ) 
 

Sets the document to transform.

Parameters:
inDoc Input the XML document to transform.

__property System::Void OSGeo::FDO::Common::Xsl::XslTransformer::set_Log OSGeo::FDO::Common::Io::IoTextWriter outDoc  ) 
 

Sets the input logging object.

Parameters:
outDoc Input the logging object

__property System::Void OSGeo::FDO::Common::Xsl::XslTransformer::set_OutDoc OSGeo::FDO::Common::Xml::XmlWriter outDoc  ) 
 

Sets the output document.

Parameters:
outDoc Input the output document
Note: The output document is not completely written until outDoc and this transformer are destroyed by releasing all references to them.

__property System::Void OSGeo::FDO::Common::Xsl::XslTransformer::set_Stylesheet OSGeo::FDO::Common::Xml::XmlReader stylesheet  ) 
 

Sets the XSL stylesheet.

Parameters:
stylesheet Input the stylesheet

System::Void OSGeo::FDO::Common::Xsl::XslTransformer::Transform  ) 
 

Performs the transformation.


Comments or suggestions? Send us feedback.