FilterWriter Class

FilterWriter is a utility class providing a convenient way to write data to an output filter (using Filter directly is not very intuitive).

Inheritance Hierarchy

SystemObject
pdftron.FiltersFilterWriter

Namespace: pdftron.Filters
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class FilterWriter : IClosable

Public NotInheritable Class FilterWriter
	Implements IClosable

public ref class FilterWriter sealed : IClosable

pdftron.Filters.FilterWriter = function();

Type.createClass(
	'pdftron.Filters.FilterWriter',
	null,
	Windows.Foundation.IClosable);

The FilterWriter type exposes the following members.

Constructors

	Name	Description
	FilterWriter	Creates a new filter writer instance.

Top

Methods

	Name	Description
	Close
	Count	Gets the number of bytes consumed since opening the filter or since the last Seek operation.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Flush	Forces any data remaining in the buffer to be read from or written to input or output filter.
	FlushAll	Forces any data remaining in the filter chain to the source or destination.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Seek	Sets the position within the current stream.
	Tell	Reports the current read position in the stream relative to the stream origin.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteBuffer	Writes a buffer to the stream.
	WriteByte	Writes a single byte to the stream.
	WriteFilter	Write the entire input stream to the output stream (i.e. to this FilterWriter).
	WriteInt(Int32)	Writes an int to the stream.
	WriteInt(Int64)	Writes an int to the stream.
	WriteLine	Writes out a null terminated 'line' followed by a end of line character default end of line character is carriage return.
	WriteString	Writes a string to the stream.
	WriteUInt(UInt32)	Writes a uint to the stream.
	WriteUInt(UInt64)	Writes a uint to the stream.

Top

Examples

Copy

StdFile outfile = new StdFile("file.dat", StdFileOpenMode.e_write_mode);
FilterWriter fwriter =n ew FilterWriter(outfile);
byte[] buf = ...
fwriter.WriteBuffer(buf);
fwriter.Flush();

Reference

pdftron.Filters Namespace