menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ToolTipItem - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ToolTipItem

    Represents a class that maintains the information of the ToolTipItem.

    Inheritance
    System.Object
    ToolTipItem
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.WinForms.Controls
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class ToolTipItem

    Constructors

    ToolTipItem()

    Initializes a new instance of the ToolTipItem class.

    Declaration
    public ToolTipItem()

    Properties

    Control

    Gets or sets a control to be added on the ToolTipItem.

    Declaration
    public Control Control { get; set; }
    Property Value
    Type
    System.Windows.Forms.Control
    Remarks

    If the control is set to the tooltip item, the text, image and other customization cannot be applied to the tooltip item. The assigned control only will be displayed in the tooltip item.

    EnableGradientBackground

    Gets or sets a value indicating whether gradient background drawing for the ToolTipItem should be enabled or not.

    Declaration
    public bool EnableGradientBackground { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The gradient brush can be set to the tooltip item by using the property which is available in the property.

    EnableSeparator

    Gets or sets a value indicating whether separator line between the ToolTipItem should be enabled or not.

    Declaration
    public bool EnableSeparator { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    If the is enabled for the tooltip item, the line will be drawn to the bottom of that tooltip item. The separator line cannot be drawn for the last tooltip item.

    Image

    Gets or sets the image of the tooltip item.

    Declaration
    public Image Image { get; set; }
    Property Value
    Type
    System.Drawing.Image

    ImageIndex

    Gets or sets the zero-based index of an image in a collection to be displayed in a tooltip item.

    Declaration
    public int ImageIndex { get; set; }
    Property Value
    Type
    System.Int32

    ImageList

    Gets or sets the System.Windows.Forms.ImageList of the tooltip item.

    Declaration
    public ImageList ImageList { get; set; }
    Property Value
    Type
    System.Windows.Forms.ImageList
    Remarks

    If the is specified, the tooltip will not consider the image from ImageList collection.

    ImageList collection will be only considered when is not specified.

    Padding

    Gets or sets the padding of the tooltip item.

    Declaration
    public Padding Padding { get; set; }
    Property Value
    Type
    System.Windows.Forms.Padding
    Remarks

    The padding is applicable for entire tooltip item i.e. tooltip item's image, text and control will be drawn based on the padding.

    Style

    Gets or sets the with settings that control the appearance of the ToolTipItem.

    Declaration
    public ToolTipVisualStyle Style { get; set; }
    Property Value
    Type
    ToolTipVisualStyle

    Text

    Gets or sets the ToolTip text of the ToolTipItem.

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

    Methods

    ToString()

    Overriden. To return a string which represents the object instance.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    Returns a string which represents the objecr instance.

    Overrides
    System.Object.ToString()
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved