Click or drag to resize

AnnotateViewerSave Method (String, IAnnotationEncoder, Int32, Boolean)

Saves an image to a file and optionally stores annotation data embedded as XMP into the file.

Namespace:  Atalasoft.Annotate.UI
Assembly:  Atalasoft.dotImage.WinControls (in Atalasoft.dotImage.WinControls.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
Copy
public void Save(
	string fileName,
	IAnnotationEncoder encoder,
	int frameIndex,
	bool saveAnnotations
)

Parameters

fileName
Type: SystemString
The filename for this image.
encoder
Type: Atalasoft.Imaging.CodecIAnnotationEncoder
An image encoder implementing the IAnnotationEncoder interface. Currently this is only supported by the JpegEncoder and TiffEncoder.
frameIndex
Type: SystemInt32
The frame index to save or -1 to save all frames.
saveAnnotations
Type: SystemBoolean
True to save the annotations embedded as XMP data.
Exceptions
ExceptionCondition
ArgumentNullException Thrown if the fileName or encoder is null (Nothing in VB).
ArgumentOutOfRangeException Thrown if the frameIndex is invalid for the image collection.
See Also