Click or drag to resize

DocumentViewerOpen Method (Stream, Int32, String, String)

Opens the specified page from an image and provides the thumbnail caption and tooltip.

Namespace:  Atalasoft.Imaging.WinControls
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 Open(
	Stream stream,
	int frameIndex,
	string caption,
	string toolTip
)

Parameters

stream
Type: System.IOStream
The stream containing the image. The stream must have read access and be seekable.
frameIndex
Type: SystemInt32
The page index to open. A value of -1 will load all pages into the DocumentViewer.
caption
Type: SystemString
The caption for the thumbnail.
toolTip
Type: SystemString
The tooltip for the thumbnail.
Exceptions
ExceptionCondition
ArgumentNullException Thrown if the stream argument is null (Nothing in VB).
ArgumentException Thrown if the stream is not seekable or does not have read access.
ArgumentOutOfRangeException Thrown if the frameIndex is out of range for this image.
See Also