ImageMan.Net Version 3 Summer 2012 Release
Caption Property
See Also  Example Send Feedback
DTI.ImageMan.Winforms Namespace > ThumbNailViewer Class : Caption Property





Glossary Item Box

Specifies the text that appears beneath each thumbnail image. Image specific information can be specified using the available placeholders:

Syntax

Visual Basic (Declaration) 
<System.ComponentModel.CategoryAttribute("Appearance")>
<System.ComponentModel.DescriptionAttribute("Specifies the caption that appears below each thumbnail")>
Public Property Caption As System.String
Visual Basic (Usage)Copy Code
Dim instance As ThumbNailViewer
Dim value As System.String
 
instance.Caption = value
 
value = instance.Caption
C# 
[System.ComponentModel.CategoryAttribute("Appearance")]
[System.ComponentModel.DescriptionAttribute("Specifies the caption that appears below each thumbnail")]
public System.string Caption {get; set;}
JScript 
System.ComponentModel.CategoryAttribute("Appearance")
System.ComponentModel.DescriptionAttribute("Specifies the caption that appears below each thumbnail")
public function get,set Caption : System.String
Managed Extensions for C++ 
[System.ComponentModel.CategoryAttribute("Appearance")]
[System.ComponentModel.DescriptionAttribute("Specifies the caption that appears below each thumbnail")]
public: __property System.string* get_Caption();
public: __property void set_Caption( 
   System.string* value
);
C++/CLI 
[System.ComponentModel.CategoryAttribute("Appearance")]
[System.ComponentModel.DescriptionAttribute("Specifies the caption that appears below each thumbnail")]
public:
property System.String^ Caption {
   System.String^ get();
   void set (    System.String^ value);
}

Remarks

The valid placeholders are:
  • %f Filename including path of image
  • %s Filename without path information
  • %w Width of Image in Pixels
  • %h Height of Image in Pixels
  • %l Length of Image File in bytes
  • %t Image Format
  • %x Horizontal Resolution of the image in pixels per inch
  • %y Vertical Resolution of the image in pixels per inch
  • %u User Created Text specific to each thumbnail.
Note: User created text can contain other valid placeholders. In other words some thumbs may show just filename, if the UserText is set to %f where as others could have other placeholders, or none.

Example

This Caption would display the Image Filename and then Width and Height on the second line.
C#Copy Code
thumb1.Caption = "s\nw x %h";

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2014 Data Techniques, Inc. All Rights Reserved.