Class ToolTipVisualStyle
Implements the functionalities that holds all information stored for a ToolTipItem.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.WinForms.Controls.Styles
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class ToolTipVisualStyle : VisualStyleBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject
Constructors
ToolTipVisualStyle()
Initializes a new instance of the ToolTipVisualStyle class.
Declaration
public ToolTipVisualStyle()
ToolTipVisualStyle(StyleInfoSubObjectIdentity)
Initializes a new instance of the ToolTipVisualStyle class.
Declaration
public ToolTipVisualStyle(StyleInfoSubObjectIdentity identity)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this StyleInfoBase. |
ToolTipVisualStyle(StyleInfoSubObjectIdentity, ToolTipVisualStyleInfoStore)
Initializes a new instance of the ToolTipVisualStyle class.
Declaration
public ToolTipVisualStyle(StyleInfoSubObjectIdentity identity, ToolTipVisualStyleInfoStore store)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this StyleInfoBase. |
ToolTipVisualStyleInfoStore | store | A ToolTipVisualStyleInfoStore that holds data for this object. All changes in this style object will be saved in the ToolTipVisualStyleInfoStore object. |
Properties
BackColor
Gets or sets the background color of the ToolTipItem.
Declaration
public Color BackColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
Default
Gets the default style of the ToolTipItem.
Declaration
public static ToolTipVisualStyle Default { get; }
Property Value
Type |
---|
ToolTipVisualStyle |
Font
Gets or sets the font of the ToolTipItem.
Declaration
public Font Font { get; set; }
Property Value
Type |
---|
System.Drawing.Font |
ForeColor
Gets or sets the foreground color of the ToolTipItem.
Declaration
public Color ForeColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
GradientBrush
Gets or sets the GradientBrush of the ToolTipItem,
if
Declaration
public BrushInfo GradientBrush { get; set; }
Property Value
Type |
---|
BrushInfo |
HasBackColor
Gets a value indicating whether the BackColor property has been modified for the current object.
Declaration
public bool HasBackColor { get; }
Property Value
Type |
---|
System.Boolean |
HasFont
Gets a value indicating whether the Font property has been modified for the current object.
Declaration
public bool HasFont { get; }
Property Value
Type |
---|
System.Boolean |
HasForeColor
Gets a value indicating whether the ForeColor property has been modified for the current object.
Declaration
public bool HasForeColor { get; }
Property Value
Type |
---|
System.Boolean |
HasGradientBrush
Gets a value indicating whether the GradientBrush property has been modified for the current object.
Declaration
public bool HasGradientBrush { get; }
Property Value
Type |
---|
System.Boolean |
HasImageAlignment
Gets a value indicating whether the ImageAlignment property has been modified for the current object.
Declaration
public bool HasImageAlignment { get; }
Property Value
Type |
---|
System.Boolean |
HasImageSize
Gets a value indicating whether the ImageSize property has been modified for the current object.
Declaration
public bool HasImageSize { get; }
Property Value
Type |
---|
System.Boolean |
HasImageToTextOffset
Gets a value indicating whether the ImageToTextOffset property has been modified for the current object.
Declaration
public bool HasImageToTextOffset { get; }
Property Value
Type |
---|
System.Boolean |
HasSeparatorColor
Gets a value indicating whether the SeparatorColor property has been modified for the current object.
Declaration
public bool HasSeparatorColor { get; }
Property Value
Type |
---|
System.Boolean |
HasSeparatorPattern
Gets a value indicating whether the SeparatorPattern property has been modified for the current object.
Declaration
public bool HasSeparatorPattern { get; }
Property Value
Type |
---|
System.Boolean |
HasSeparatorStyle
Gets a value indicating whether the SeparatorStyle property has been modified for the current object.
Declaration
public bool HasSeparatorStyle { get; }
Property Value
Type |
---|
System.Boolean |
HasTextAlignment
Gets a value indicating whether the TextAlignment property has been modified for the current object.
Declaration
public bool HasTextAlignment { get; }
Property Value
Type |
---|
System.Boolean |
ImageAlignment
Gets or sets the alignment of the image on the ToolTipItem.
Declaration
public ToolTipImageAlignment ImageAlignment { get; set; }
Property Value
Type |
---|
ToolTipImageAlignment |
Remarks
If the ToolTipItem has both the text and image and
ImageSize
Gets or sets the size of the
Declaration
public Size ImageSize { get; set; }
Property Value
Type |
---|
System.Drawing.Size |
ImageToTextOffset
Gets or sets the offset space between the image and text of the tooltip item.
Declaration
public int ImageToTextOffset { get; set; }
Property Value
Type |
---|
System.Int32 |
SeparatorColor
Gets or sets the separator color of the ToolTipItem to draw separator,
if
Declaration
public Color SeparatorColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
SeparatorPattern
Gets or sets the separator pattern of the ToolTipItem to draw separator,
if
Declaration
public float[] SeparatorPattern { get; set; }
Property Value
Type |
---|
System.Single[] |
SeparatorStyle
Gets or sets the separator style of the ToolTipItem to draw separator,
if
Declaration
public DashStyle SeparatorStyle { get; set; }
Property Value
Type |
---|
System.Drawing.Drawing2D.DashStyle |
TextAlignment
Gets or sets the TextAlignment of the ToolTipItem.
Declaration
public ContentAlignment TextAlignment { get; set; }
Property Value
Type |
---|
System.Drawing.ContentAlignment |
Methods
CreateSubObjectIdentity(StyleInfoProperty)
Override this method to create a product-specific identity object for a sub object.
Declaration
public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoProperty | sip | The StyleInfoProperty. |
Returns
Type | Description |
---|---|
StyleInfoSubObjectIdentity | An identity object for a sub object of this style. |
Overrides
Examples
The following code is an example how Essential Grid creates GridStyleInfoSubObjectIdentity:
public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
{
return new GridStyleInfoSubObjectIdentity(this, sip);
}
GetDefaultStyle()
Gets the default style of the ToolTipItem.
Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type | Description |
---|---|
StyleInfoBase | Default style of the ToolTipItem. |
Overrides
MakeCopy(StyleInfoBase, StyleInfoProperty)
Makes an exact copy of the current object.
Declaration
public override IStyleInfoSubObject MakeCopy(StyleInfoBase newOwner, StyleInfoProperty sip)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoBase | newOwner | The new owner style object for the copied object. |
StyleInfoProperty | sip | The identifier for this object. |
Returns
Type | Description |
---|---|
IStyleInfoSubObject | A copy of the current object registered with the new owner style object. |