WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ScreenTip

    Show / Hide Table of Contents

    Class ScreenTip

    Control that extends possibilities of standard tooltip.

    Inheritance
    System.Object
    ScreenTip
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    public class ScreenTip : ToolTip

    Constructors

    ScreenTip()

    Initializes a new instance of the ScreenTip class.

    Declaration
    public ScreenTip()

    Fields

    DescriptionProperty

    Defines description of tooltip. This is a dependency property.

    Declaration
    public static readonly DependencyProperty DescriptionProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    HelpIconProperty

    Defines HelpTextIcon. This is a dependency property.

    Declaration
    public static readonly DependencyProperty HelpIconProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    HelpTextProperty

    Represents the Help text, This is a Dependency property

    Declaration
    public static readonly DependencyProperty HelpTextProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ImageSourceProperty

    Defines ScreenTip image. This is a dependency property.

    Declaration
    public static readonly DependencyProperty ImageSourceProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    Description

    Gets or sets the description of the ScreenTip.

    Declaration
    public string Description { get; set; }
    Property Value
    Type Description
    System.String

    Type: System.String Text that will be displayed as tooltip description, default is empty string.

    Examples
    ScreenTip screenTip;
    // ....
    screenTip.Description = "Description";
    See Also
    System.String
    ScreenTip

    HelpIcon

    Gets or sets the image of HelpIcon

    Declaration
    public ImageSource HelpIcon { get; set; }
    Property Value
    Type Description
    System.Windows.Media.ImageSource

    HelpText

    Gets or sets the help text.

    Declaration
    public string HelpText { get; set; }
    Property Value
    Type Description
    System.String

    The help text.

    ImageSource

    Gets or sets the image that appears in a ScreenTip.

    Declaration
    public ImageSource ImageSource { get; set; }
    Property Value
    Type Description
    System.Windows.Media.ImageSource
    Remarks

    Many controls have more than just text in the element. Often there is an image.

    Examples
    ScreenTip screenTip = new ScreenTip();
    // Create source.
    BitmapImage bimage = new BitmapImage();
    // BitmapImage.UriSource must be in a BeginInit/EndInit block.
    bimage.BeginInit();
    bimage.UriSource = new Uri(@"/sampleImages/sample.jpg",UriKind.RelativeOrAbsolute);
    bimage.EndInit();
    // Set the image source.
    screenTip.ImageSource = bimage;
    See Also
    ScreenTip
    ImageSource

    Methods

    OnDescriptionChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises DescriptionChanged event.

    Declaration
    protected virtual void OnDescriptionChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property changes details, such as old value and new value.

    OnHelpImageChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises ImageSourceChanged event.

    Declaration
    protected virtual void OnHelpImageChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property changes details, such as old value and new value.

    OnHelpTextChanged(DependencyPropertyChangedEventArgs)

    Raises the HelpTextChanged event.

    Declaration
    protected virtual void OnHelpTextChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

    OnImageSourceChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises ImageSourceChanged event.

    Declaration
    protected virtual void OnImageSourceChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property changes details, such as old value and new value.

    OnIsOpenChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises IsOpenChanged event.

    Declaration
    protected virtual void OnIsOpenChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property changes details, such as old value and new value.

    Events

    DescriptionChanged

    Event that is raised when Description property is changed.

    Declaration
    public event PropertyChangedCallback DescriptionChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    HelpImageChanged

    Event that is raised when HelpIamge property is changed.

    Declaration
    public event PropertyChangedCallback HelpImageChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    HelpTextChanged

    Occurs when [help text changed].

    Declaration
    public event PropertyChangedCallback HelpTextChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    ImageSourceChanged

    Event that is raised when ImageSource property is changed.

    Declaration
    public event PropertyChangedCallback ImageSourceChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    IsOpenChanged

    Event that is raised when IsOpen property is changed.

    Declaration
    public event PropertyChangedCallback IsOpenChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved