DocumentViewerOpen Method (String, Int32, String, String) |
Opens the specified frame 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 public void Open(
string fileName,
int frameIndex,
string caption,
string toolTip
)
Public Sub Open (
fileName As String,
frameIndex As Integer,
caption As String,
toolTip As String
)
Parameters
- fileName
- Type: SystemString
The filename of the image. - 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 Exception | Condition |
---|
ArgumentNullException | Thrown if the filename is null (Nothing in VB) or an empty string. |
FileNotFoundException | Thrown if the file cannot be found. |
ArgumentOutOfRangeException | Thrown if the frameIndex is out of range for this image. |
See Also