GrapeCity.Documents.Imaging.Windows.GcWicTiffWriter

Class GcWicTiffWriter

Namespace

GrapeCity.Documents.Imaging.Windows

Assembly

GcDocs.Imaging.Windows.dll

Allows creating a multipage TIFF file.

public class GcWicTiffWriter : IDisposable

Inheritance

object

GcWicTiffWriter

Implements

System.IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

GcWicTiffWriter(Stream, bool, ImagingFactory)

Initializes a new instance of GcWicTiffWriter class and sets the output stream.

public GcWicTiffWriter(Stream stream, bool ownStream = false, ImagingFactory imagingFactory = null)

Parameters

stream System.IO.Stream

The output stream.

ownStream bool

Indicates whether the output stream should be disposed together with GcWicTiffWriter.

imagingFactory ImagingFactory

The existing imaging factory, to avoid duplicating factories.

GcWicTiffWriter(string, ImagingFactory)

Initializes a new instance of GcWicTiffWriter class and sets the output file.

public GcWicTiffWriter(string filePath, ImagingFactory imagingFactory = null)

Parameters

filePath string

Full path to the output file.

imagingFactory ImagingFactory

The existing imaging factory, to avoid duplicating factories.

Properties

CompressionLevel

Gets or sets the compression level (0.0, 1.0).

0.0 means the least efficient but fast compression. 1.0 means the most efficient scheme available, typically taking more time to encode but producing smaller output.

public float CompressionLevel { get; set; }

Property Value

float

CompressionMethod

Gets or sets the TIFF compression method.

public WicTiffCompression CompressionMethod { get; set; }

Property Value

WicTiffCompression

CurrentFrame

Gets the current frame's GcWicBitmap.

public GcWicBitmap CurrentFrame { get; }

Property Value

GcWicBitmap

DefaultFrameHeight

Gets or sets the default height of a frame, in DIPs.

public float DefaultFrameHeight { get; set; }

Property Value

float

DefaultFrameWidth

Gets or sets the default width of a frame, in DIPs.

public float DefaultFrameWidth { get; set; }

Property Value

float

FrameTransform

Gets or sets the transformation chain to be applied to the next saved frame.

public BaseTransform[] FrameTransform { get; set; }

Property Value

BaseTransform[]

Opaque

Gets or sets a value indicating if the image is opaque.

public bool Opaque { get; set; }

Property Value

bool

Resolution

Gets or sets the DPI resolution of the image.

public float Resolution { get; set; }

Property Value

float

Methods

AppendFrame(GcWicBitmap)

Writes the specified bitmap to the output stream as the next frame.

public void AppendFrame(GcWicBitmap wicBitmap)

Parameters

wicBitmap GcWicBitmap

ApplyLicenseKey(string)

Applies a license key to an instance of GcWicTiffWriter.

public void ApplyLicenseKey(string key)

Parameters

key string

The license key to set.

Dispose()

Clean up any resources being used.

public void Dispose()

Dispose(bool)

Performs cleanup operations on managed and unmanaged resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

~GcWicTiffWriter()

Performs cleanup operations on unmanaged resources.

protected ~GcWicTiffWriter()

NewFrame()

Saves the previous frame to the output stream and creates a new frame with default width and height.

public GcWicBitmap NewFrame()

Returns

GcWicBitmap

The new frame.

NewFrame(float, float)

Saves the previous frame to the output stream and creates a new frame with specified width and height.

public GcWicBitmap NewFrame(float width, float height)

Parameters

width float

The width of the new frame, in DIPs.

height float

The height of the new frame, in DIPs.

Returns

GcWicBitmap

The new frame.

SetFontCache(FontCache)

Assigns a shared instance of the FontCache object.

public void SetFontCache(FontCache fontCache)

Parameters

fontCache FontCache