Click or drag to resize

ImageFromLocalDrive Class

Image from local drive class.

This class will trigger ImageFromLocalDrivePropertyChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DMImageFromLocalDrive

Namespace: Crestron.SimplSharpPro.DM
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public sealed class ImageFromLocalDrive : IParentInformation

The ImageFromLocalDrive type exposes the following members.

Properties
 NameDescription
Public propertyErrorCodeFeedback Property to report an error code during image retrieval. Zero will be returned incase of success.

The ImageFromLocalDrivePropertyChange event will trigger with ErrorCodeFeedbackEventId.

Public propertyErrorTextFeedback Property to report the error text during image retrieval.

The ImageFromLocalDrivePropertyChange event will trigger with ErrorTextFeedbackEventId.

Public propertyImageSelectedFeedback Collection of selected images. This property value shall also be set if the SelectImageByIndex is set to any value between 1 and 20.

The ImageFromLocalDrivePropertyChange event will trigger with ImageSelectedFeedbackEventId.

Public propertyParent The parent that a ImageFromLocalDrive object was added to.
Public propertySelectImageByIndex Property to select the image by index. Value 0 means clear all, no image selected. Valid values are 0 to 20.
Public propertySelectImageByIndexFeedback Property to report the index of selected image.

The ImageFromLocalDrivePropertyChange event will trigger with SelectImageByIndexFeedbackEventId.

Public propertySelectImageByName Property to look up the image by a name. If nothing is found, reports an error to ErrorCodeFeedback.
Public propertySelectImageByNameFeedback Property to report the name of selected image.

The ImageFromLocalDrivePropertyChange event will trigger with SelectImageByNameFeedbackEventId.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodSelectImage Method to select image at the corresponding index. Valid range is 1 to 20. Invalid values are ignored. Image number which is selected.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventImageFromLocalDrivePropertyChange Event triggered when a feedback has changed for this ImageFromLocalDrive.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also