ThumbnailCaption Property (WpfThumbnailViewer)

In This Topic

Gets or sets caption of a thumbnail.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

<DescriptionAttribute("Caption of a thumbnail.")>
<CategoryAttribute("VintaSoft")>
<TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)>
Public Property ThumbnailCaption As ThumbnailImageItemCaption

[Description("Caption of a thumbnail.")]
[Category("VintaSoft")]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
public ThumbnailImageItemCaption ThumbnailCaption { get; set; }

[Description("Caption of a thumbnail.")]
[Category("VintaSoft")]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
public: __property ThumbnailImageItemCaption* get_ThumbnailCaption();
public: __property void set_ThumbnailCaption(
   ThumbnailImageItemCaption* value
);

[Description("Caption of a thumbnail.")]
[Category("VintaSoft")]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
public:
property ThumbnailImageItemCaption^ ThumbnailCaption {
   ThumbnailImageItemCaption^ get();
   void set(ThumbnailImageItemCaption^ value);
}

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if value is null.

Example

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

VB.NET


''' <summary>
''' Sets the custom thumbnail caption.
''' </summary>
''' <param name="thumbnailViewer">The thumbnail viewer.</param>
Public Shared Sub SetThumbnailCaption(thumbnailViewer As Vintasoft.Imaging.Wpf.UI.WpfThumbnailViewer)
    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.Wpf.UI.WpfThumbnailViewer 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

Reference

WpfThumbnailViewer Class
WpfThumbnailViewer Members

ThumbnailImagePadding
ThumbnailCaptionFormat
ThumbnailCaptionColor
ThumbnailCaptionAnchor
ThumbnailCaptionPadding

Send Feedback