VintaSoft Imaging .NET SDK 14.0: Documentation for .NET developer
Vintasoft.Imaging.UI Namespace / ThumbnailViewer Class / ThumbnailCaption Property
Syntax Example Requirements SeeAlso
In This Topic
    ThumbnailCaption Property (ThumbnailViewer)
    In This Topic
    Gets or sets caption of a thumbnail.
    Syntax
    'Declaration
    
    <CategoryAttribute("VintaSoft")>
    <TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)>
    <DesignerSerializationVisibilityAttribute(Visible)>
    <DescriptionAttribute("Caption of a thumbnail.")>
    Public Property ThumbnailCaption As ThumbnailCaption
    
    
    [Category("VintaSoft")]
    [TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
    [DesignerSerializationVisibility(Visible)]
    [Description("Caption of a thumbnail.")]
    public ThumbnailCaption ThumbnailCaption { get; set; }
    
    
    [Category("VintaSoft")]
    [TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
    [DesignerSerializationVisibility(Visible)]
    [Description("Caption of a thumbnail.")]
    public: __property ThumbnailCaption* get_ThumbnailCaption();
    public: __property void set_ThumbnailCaption(
    ThumbnailCaption* value
    );
    [Category("VintaSoft")]
    [TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
    [DesignerSerializationVisibility(Visible)]
    [Description("Caption of a thumbnail.")]
    public:
    property ThumbnailCaption^ ThumbnailCaption { ThumbnailCaption^ get(); void set(ThumbnailCaption^ value); }
    Example

    This C#/VB.NET code shows how to set thumbnail caption:

    
    ''' <summary>
    ''' Sets the custom thumbnail caption.
    ''' </summary>
    ''' <param name="thumbnailViewer">The thumbnail viewer.</param>
    Public Shared Sub SetThumbnailCaption(thumbnailViewer As Vintasoft.Imaging.UI.ThumbnailViewer)
        thumbnailViewer.ThumbnailCaption.CaptionFormat = "File {Filename}, page {PageNumber}"
        thumbnailViewer.ThumbnailCaption.IsVisible = True
    End Sub
    
    
    
    /// <summary>
    /// Sets the custom thumbnail caption.
    /// </summary>
    /// <param name="thumbnailViewer">The thumbnail viewer.</param>
    public static void SetThumbnailCaption(Vintasoft.Imaging.UI.ThumbnailViewer thumbnailViewer)
    {
        thumbnailViewer.ThumbnailCaption.CaptionFormat = "File {Filename}, page {PageNumber}";
        thumbnailViewer.ThumbnailCaption.IsVisible = true;
    }
    
    

    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