Saxon.Api

 

 

Saxon.Api

Class XmlWriterDestination

public class XmlWriterDestination
extends net.sf.saxon.s9api.AbstractDestination
implements IDestination

An XmlWriterDestination is an implementation of XmlDestination that wraps an instance of XmlWriter.

The class was previously named TextWriterDestination, but this was a misnomer.

Note that when an XmlWriterDestination is used to process the output of a stylesheet or query, the output format depends only on the way the underlying XmlWriter is configured; serialization parameters present in the stylesheet or query are ignored. The XSLT disable-output-escaping option is also ignored. If serialization is to be controlled from the stylesheet or query, use a Serializer as the Destination.

Constructor Summary
XmlWriterDestination (XmlWriter writer)

Construct a XmlWriterDestination

 

Property Summary
 bool CloseAfterUse

The CloseAfterUse property indicates whether the underlying XmlWriter is closed (by calling its Close() method) when Saxon has finished writing to it. The default value is true, in which case Close() is called. If the property is set to false, Saxon will refrain from calling the Close() method, and merely call Flush(), which can be useful if further output is to be written to the XmlWriter by the application.

 net.sf.saxon.s9api.Destination UnderlyingDestination

The underlying Destination object in the Saxon implementation

 

Method Summary
 void close ()

Close any resources associated with this destination. Note that this does not close any user-supplied OutputStream or Writer; those must be closed explicitly by the calling application.

 net.sf.saxon.@event.Receiver getReceiver (net.sf.saxon.event.PipelineConfiguration pipe, net.sf.saxon.serialize.SerializationProperties value2)

Return a Receiver. Saxon calls this method to obtain a Java Receiver, to which it then sends a sequence of events representing the content of an XML document. The method is intended primarily for internal use, and may give poor diagnostics if used incorrectly.

 void OnClose (Action action)

Define an action to be performed when writing to the Destination is complete.

 

Constructor Detail

XmlWriterDestination

public XmlWriterDestination(XmlWriter writer)

Construct a XmlWriterDestination

Parameters:

writer - The XmlWriter that is to be notified of the events representing the XML document.

Property Detail

CloseAfterUse

public bool CloseAfterUse {get; set; }

The CloseAfterUse property indicates whether the underlying XmlWriter is closed (by calling its Close() method) when Saxon has finished writing to it. The default value is true, in which case Close() is called. If the property is set to false, Saxon will refrain from calling the Close() method, and merely call Flush(), which can be useful if further output is to be written to the XmlWriter by the application.

UnderlyingDestination

public net.sf.saxon.s9api.Destination UnderlyingDestination {get; }

The underlying Destination object in the Saxon implementation

This property provides access to internal methods in the Saxon engine that are not specifically exposed in the .NET API. In general these methods should be considered to be less stable than the classes in the Saxon.Api namespace.

The internal methods follow Java naming conventions rather than .NET conventions.

Information about the returned net.sf.saxon.s9api.Destination object (and the objects it provides access to) is included in the Saxon JavaDoc documentation.

Value:

The underlying Destination object

Method Detail

close

public override void close()

Close any resources associated with this destination. Note that this does not close any user-supplied OutputStream or Writer; those must be closed explicitly by the calling application.

getReceiver

public override net.sf.saxon.@event.Receiver getReceiver(net.sf.saxon.event.PipelineConfiguration pipe,
net.sf.saxon.serialize.SerializationProperties value2)

Return a Receiver. Saxon calls this method to obtain a Java Receiver, to which it then sends a sequence of events representing the content of an XML document. The method is intended primarily for internal use, and may give poor diagnostics if used incorrectly.

Parameters:

pipe - The Saxon configuration as a JPipelineConfiguration. This is supplied so that the destination can use information from the configuration (for example, a reference to the name pool) to construct or configure the returned Receiver.
value2 - Serialization parameters known to the caller of the method; typically, output properties defined in a stylesheet or query. These will mainly be of interest if the destination is performing serialization, but some properties (such as item-separator) are also used in other situations.

Returns:

The receiver

OnClose

public void OnClose(Action action)

Define an action to be performed when writing to the Destination is complete.

Parameters:

action - The action to be performed.