IScreenHistory Interface Members

Reflection

Properties Methods Events Collapse All Members Options: Show All

Include Inherited Members

The following tables list the members exposed by IScreenHistory.

Public Properties

	Name	Description
	ClearHistoryOnDisconnect	Gets or sets a value for whether to clear the screen list when the session disconnects (if true).
	Count	Returns the number of screens listed in the Screen History of the session.
	Index	Returns the zero-based index of the current history screen or -1 if the live screen is active.
	ManualCaptureOnly	Gets or sets whether host screens are only captured manually (true) or if they're captured automatically (false).
	NumberOfScreensToRemember	Gets or sets the number of host screens in the Screen History list.
	Parent	Gets the parent object (IProductivity).
	ScreenHistoryPanelVisible	Gets or sets the visible state of the dockable Screen History panel.

Public Methods

	Name	Description
	Back	Shows the previous host screen from the Screen History list in read-only mode.
	CaptureScreen	Captures the current host screen, including any data entered in non-hidden fields, and adds it to the Screen History list.
	ClearAllScreens	Remove all screens from the Screen History list.
	DeleteScreen	Deletes a specific screen from the Screen History list.
	Forward	Shows the next host screen from the Screen History list in read-only mode.
	GetHistoryScreenImage	Returns a history screen as an image.
	GetLiveScreenImage	Returns the live screen as an image.
	OpenScreenHistoryFile	Loads a screen history file into the session document.
	SaveScreenHistoryFile	Saves screen history contents to the specified file.
	ShowLiveScreen	Shows the current host screen from anywhere in the screen history sequence.
	ShowScreen	Shows a specific screen from the Screen History list.

Public Events

	Name	Description
	ScreenChanged	Raised when screens are added to or deleted from the Screen History list.
	ScreenSelected	Raised when a history screen has been selected.

Send Feedback