thumbnailCaptionFormat Property

In This Topic

Gets or sets the string format for thumbnail caption for all the thumbnails in the control.

Syntax

ASP.NET Ajax JavaScript (Specification)
function get_thumbnailCaptionFormat() : Boolean function set_thumbnailCaptionFormat(value : Boolean)

ASP.NET Ajax JavaScript (Usage)
var resultVar = instanceOfImGearThumbnailList.get_thumbnailCaptionFormat();

Remarks

This property gets or sets the string format for thumbnail caption for all the thumbnails in the control. The custom formatting supports templated caption. The string will be parsed with the following characters to mean as in the following list. Note: The internal parser expects the characters to be encased within {}. To specify a single literal brace character in the format, specify two opening or closing braces. This follows .NET rules for escaping curly braces.

DC - Document Caption: Defined by 'caption' property in the ImGearDocument class.
PC - Page Caption: Defined by the page 'caption' property of the ImageGear.Web.UI.ImGearPage' class.
P# - Page Index: Defined by the page index in the ImGearPageCollection contained in the ImGearDocument class (Note: The displayed index will be incremented by one since the index is zero based)
PN - Page Number: Defined by the pageNumber property of the ImageGear.Web.UI.ImGearPage' class (Note: The displayed index will be incremented by one since the page number is zero based)
PP - Page Count: Defined by the total number of pages in the ImGearPageCollection contained in the ImGearDocument class.

Example:

Property value = "Title-{DC}:{PC} {P#} of {PP}"

The resulting caption for thumbnails will be like:

"Title-MyImage.tif:Claims Page 1 of 150"

Property value = "{DC}:Page {P#}"

The resulting caption for thumbnails will be:

"MyImage.tif:Page 1"

Reference

ImGearThumbnailList class
ImGearThumbnailList Members

Get Product Support