VintaSoft Imaging .NET SDK 14.0: Documentation for .NET developer
Vintasoft.Imaging.Wpf.UI Namespace / WpfThumbnailViewer Class / ThumbnailCaptionFormat Property
Syntax Requirements SeeAlso
In This Topic
    ThumbnailCaptionFormat Property (WpfThumbnailViewer)
    In This Topic
    Gets or sets the thumbnail caption format string. This is a dependency property.
    Syntax
    'Declaration
    
    <DefaultValueAttribute("")>
    <CategoryAttribute("VintaSoft")>
    <DescriptionAttribute("The thumbnail caption format string. This is a dependency property.")>
    Public Property ThumbnailCaptionFormat As System.String
    
    
    [DefaultValue("")]
    [Category("VintaSoft")]
    [Description("The thumbnail caption format string. This is a dependency property.")]
    public System.String ThumbnailCaptionFormat { get; set; }
    
    
    [DefaultValue("")]
    [Category("VintaSoft")]
    [Description("The thumbnail caption format string. This is a dependency property.")]
    public: __property System.String get_ThumbnailCaptionFormat();
    public: __property void set_ThumbnailCaptionFormat(
    System.String value
    );
    [DefaultValue("")]
    [Category("VintaSoft")]
    [Description("The thumbnail caption format string. This is a dependency property.")]
    public:
    property System.String ThumbnailCaptionFormat { System.String get(); void set(System.String value); }

    Property Value

    List of predefined caption format variables:
    • {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
    • {Filename} - filename without directory
    • {FullFilename} - full filename
    • {DirectoryName} - directory name
    • {DecoderName} - decoder name
    • {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

    Examples of caption format:
    • {PageNumber}
    • File {Filename}, page {PageNumber}
    • {ImageSizeMpx:f2} MPX
    Requirements

    Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

    See Also