iItemViewerPrototyper Interface

Code Details

Library

ItemViewer

Viewers

iItemViewerPrototyper Interface

Interface for the item viewer prototyper, which is used for all viewer functions (such as writing the menu HTML, determining inclusion in an item, determining access, etc..) NOT included in the item viewer. Objects that implement this interface also generate the item viewer

Namespace: SobekCM.Library.ItemViewer.Viewers
Assembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public interface iItemViewerPrototyper

Remarks

This prototyper is generally reserved and works as a singleton, so no individual digital resource or request-specific data should be saved in classes that implement this interface.

Methods

	Name	Description
	Add_Menu_items	Gets the menu items related to this viewer that should be included on the main item (digital resource) menu
	Create_Viewer	Creates and returns the item viewer for this viewer type
	Has_Access	Flag indicates if the current user has access to this viewer for the item
	Include_Viewer	Indicates if the specified item matches the basic requirements for this viewer, or if this viewer should be ignored for this item
	Override_On_Checkout	Flag indicates if this viewer should be override on checkout

Properties

	Name	Description
	FileExtensions	If this viewer is tied to certain files existing in the digital resource, this lists all the possible file extensions this supports (from the configuration file usually)
	ViewerCode	Code for this viewer, which can also be set from the configuration information
	ViewerType	Name of this viewer, which matches the viewer name from the database and in the configuration files as well. This is actually populate by the configuration information

iItemViewerPrototyper Interface

Syntax

Remarks

Methods

Properties

See Also