VintaSoft Imaging .NET SDK 14.0: Documentation for Web developer
Vintasoft.Imaging.UI Namespace / WebThumbnailViewerJS type / set_ThumbnailCaptionFormat Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
In This Topic
    set_ThumbnailCaptionFormat Method
    In This Topic
    Sets a thumbnail caption format string.
    Syntax
    var instance = new Vintasoft.Imaging.UI.WebThumbnailViewerJS(controlId);
    
    var returnValue; // Type: any
    
    // Parameters
    var value; // Type: string
    
    returnValue = instance.set_ThumbnailCaptionFormat(value);
    
    
    function set_ThumbnailCaptionFormat(
    value
    Thumbnail caption format string. Default value is "{ImageNumber}".
    : string
    ) : any;

    Parameters

    value
    Thumbnail caption format string. Default value is "{ImageNumber}".
    Exceptions
    ExceptionDescription
    Thrown if argument has wrong type.
    Remarks

    Format string can contain the following keys:

    • {FileId} - key, which will be replaced by the thumbnail image identifier (get_ImageId).
    • {PageNumber} - page number in source image file
    • {PageIndex} - zero-based page index in source image file
    • {ImageNumber} - image number in image collection
    • {ImageIndex} - zero-based image index in image collection
    • {ImageWidthPx} - source image width, in pixels
    • {ImageHeightPx} - source image height, in pixels
    • {ImageSizeMpx} - source image size, in megapixels
    • {ImageHRes} - source image horizontal resolution, in DPI
    • {ImageVRes} - source image vertical resolution, in DPI

    Browser Compatibility
    56+
    45+
    11
    See Also