VintaSoft Imaging .NET SDK 14.0: Documentation for .NET developer
Vintasoft.Imaging.Dicom.Wpf.UI.VisualTools Namespace / WpfRuntimeInfoTextOverlay Class / TextFormat Property
Syntax Exceptions Requirements SeeAlso
In This Topic
    TextFormat Property (WpfRuntimeInfoTextOverlay)
    In This Topic
    Gets or sets the text format.
    Syntax
    'Declaration
    
    <DescriptionAttribute("The text format.
    Supported keys:
    "SeriesImageNumber" - image number in series
    "SeriesImageCount" - image count in series
    "WindowCenter" - window center of the Value Of Interest Look Up Table
    "WindowWidth" - window width of the Value Of Interest Look Up Table
    "FileName" - the file name
    ")>
    Public Property TextFormat As System.String
    
    
    [Description("The text format.
    Supported keys:
    "SeriesImageNumber" - image number in series
    "SeriesImageCount" - image count in series
    "WindowCenter" - window center of the Value Of Interest Look Up Table
    "WindowWidth" - window width of the Value Of Interest Look Up Table
    "FileName" - the file name
    ")]
    public System.String TextFormat { get; set; }
    
    
    [Description("The text format.
    Supported keys:
    "SeriesImageNumber" - image number in series
    "SeriesImageCount" - image count in series
    "WindowCenter" - window center of the Value Of Interest Look Up Table
    "WindowWidth" - window width of the Value Of Interest Look Up Table
    "FileName" - the file name
    ")]
    public: __property System.String get_TextFormat();
    public: __property void set_TextFormat(
    System.String value
    );
    [Description("The text format.
    Supported keys:
    "SeriesImageNumber" - image number in series
    "SeriesImageCount" - image count in series
    "WindowCenter" - window center of the Value Of Interest Look Up Table
    "WindowWidth" - window width of the Value Of Interest Look Up Table
    "FileName" - the file name
    ")]
    public:
    property System.String TextFormat { System.String get(); void set(System.String value); }

    Property Value

    Default value is Im: {SeriesImageNumber}/{SeriesImageCount}.
    Supported keys:
    • "SeriesImageNumber" - image number in series
    • "SeriesImageCount" - image count in series
    • "WindowCenter" - window center of VOI LUT
    • "WindowWidth" - window width of VOI LUT
    • "FileName" - the file name
    Exceptions
    ExceptionDescription
    Thrown if value is not correct.
    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