ObjectDCL Banner

SlideView_Load Method

Description

This method loads a slide image or slide library and then displays the slide in the control.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
FileName
String specifying the path to the file.
SlideLibraryImageName
String specifying the image name to load.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_SlideView_Load 
		MyControlReference [as Reference]
		FileName [as String]
		[Optional] SlideLibraryImageName [as String])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_SlideView_Load
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		FileName [as String]
		[Optional] SlideLibraryImageName [as String])

Applies For

SlideView.

Example

CopyCode imageCopy Code
; Load the slide
(Odcl_SlideView_Load MyProject_MyForm_MyControl "New inserted text")

See Also

SlideView_Clear