Show / Hide Table of Contents

Interface ICpDocument

Represents a printable document, which can be finally output in one or more data formats.

Namespace: StarMicronics.CloudPrnt
Assembly: cs.temp.dll.dll
Syntax
public interface ICpDocument

Properties

JobConversionOptions

Specify parameters that will be used to direct the conversion of a print job.

Declaration
ConversionOptions JobConversionOptions { get; set; }
Property Value
Type Description
ConversionOptions

Conversion parameters which may affect the result when an ICpDocument object performs conversion from its input document data to a requested output.

NativeFormat

Returns the native format that was used to create the document, as an internet IANA/MIME format

Declaration
string NativeFormat { get; }
Property Value
Type Description
System.String

The native format that was used to create the document, as an internet IANA/MIME format

OutputFormats

A list of output media types that can be generated by the instantiated ICpDocument compatible object.

Declaration
string[] OutputFormats { get; }
Property Value
Type Description
System.String[]

A list if IANA/MIME media type formats that an ICpDocument can convert it's source document to.

Methods

convertTo(String, Stream)

Convert the active job into data compatible with the requested media format.

Declaration
void convertTo(string requestFormat, Stream outStream)
Parameters
Type Name Description
System.String requestFormat

A String specifying the requested media format.

System.IO.Stream outStream

Writeable Stream object that the converted data will be written to.

In This Article
Back to top