VintaSoft Imaging .NET SDK 14.0: Documentation for .NET developer
Vintasoft.Imaging.UI Namespace / ThumbnailCaption Class / CaptionFormat Property
Syntax Requirements SeeAlso
In This Topic
    CaptionFormat Property (ThumbnailCaption)
    In This Topic
    Gets or sets the caption format string.
    Syntax
    'Declaration
    
    <DescriptionAttribute("The caption format string.")>
    <DefaultValueAttribute("{PageNumber}")>
    Public Property CaptionFormat As System.String
    
    
    [Description("The caption format string.")]
    [DefaultValue("{PageNumber}")]
    public System.String CaptionFormat { get; set; }
    
    
    [Description("The caption format string.")]
    [DefaultValue("{PageNumber}")]
    public: __property System.String get_CaptionFormat();
    public: __property void set_CaptionFormat(
    System.String value
    );
    [Description("The caption format string.")]
    [DefaultValue("{PageNumber}")]
    public:
    property System.String CaptionFormat { 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
    • {PageCount} - page count, 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
    • {ImageBitsPerPixel} - source image bits per pixel
    • {PageLabel} - PageLabel
    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