[This is preliminary documentation and is subject to change.]

Gets or sets image key - it can be either path to image file Total Commander should extract miniature from or unique key of image or null

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
public string ImageKey { get; set; }
Visual Basic
Public Property ImageKey As String
	Get
	Set
Visual C++
public:
property String^ ImageKey {
	String^ get ();
	void set (String^ value);
}
F#
member ImageKey : string with get, set
JScript
function get ImageKey () : String
function set ImageKey (value : String)

Field Value

When Image is null this property represents path to image file containing miniature image.

When Image is not null this property represents unique image key. Total Commander then caches the image under that key.

Return Value

Image key

Remarks

When both - Image and ImageKey are null, Total Commander will be left with original image path as path to load miniature from. But the path targets to plugin file system space - so it is invalid from Total Commmander perspective. So, do not set both Image and ImageKey to null.

Exceptions

ExceptionCondition
System.IO..::..PathTooLongExceptionValue longer than - 1 is set

See Also