Class GridCommentTipInfo

Implements the functionalities that provides a StyleInfoSubObjectBase object for CommentTip properties in a cell.

Each property in this sub object can be configured individually. Properties that have not been initialized will inherit default values from a base style.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
StyleInfoSubObjectBase
GridCommentTipInfo
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridCommentTipInfo : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

GridCommentTipInfo()

Initializes a new empty instance ofGridCommentTipInfo class.

Declaration
public GridCommentTipInfo()

GridCommentTipInfo(StyleInfoSubObjectIdentity)

Initializes a new instance ofGridCommentTipInfo object and associates it with an existing GridStyleInfoSubObjectIdentity.

Declaration
public GridCommentTipInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A GridStyleInfoSubObjectIdentity that holds the identity for this GridCommentTipInfo.

GridCommentTipInfo(StyleInfoSubObjectIdentity, GridCommentTipInfoStore)

Initializes a new instance ofGridCommentTipInfo object and associates it with an existing GridCommentTipInfo.

Declaration
public GridCommentTipInfo(StyleInfoSubObjectIdentity identity, GridCommentTipInfoStore store)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A GridStyleInfoSubObjectIdentity that holds the identity for this GridCommentTipInfo.
GridCommentTipInfoStore store

A GridCommentTipInfoStore that holds data for this GridCommentTipInfoStore. All changes in this style object will saved in the GridCommentTipInfoStore object.

Properties

BackColor

Gets or sets the back color of the comment tip window.

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

CommentArrowColor

Gets or sets the color of the comment arrow.

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

CommentArrowSize

Gets or sets the arrow size for pointing the comment tip window.

Declaration
public Size CommentArrowSize { get; set; }
Property Value
Type
System.Drawing.Size
Remarks

The comment tip window location is based on the comment arrow height. To avoid displaying the comment arrow, set the CommentArrowSize.Width to zero or CommentArrowSize.Height.

CommentFont

Gets or sets the font of text displayed in the comment tip window.

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

CommentImage

Gets or sets the image displayed in the comment tip window.

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

CommentIndicatorColor

Gets or sets the color to draw the comment indicator.

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

CommentIndicatorSize

Gets or sets the size of the comment tip indicator.

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

CommentText

Gets or sets the text that need to be displayed in the comment tip window.

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

CommentWindowSize

Gets or sets the size of the comment tip window.

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

Default

Gets the default values for the GridCommentTipInfo properties.

Declaration
public static GridCommentTipInfo Default { get; }
Property Value
Type
GridCommentTipInfo

ForeColor

Gets or sets the ForeColor of text that displayed in the comment tip window.

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

HasBackColor

Gets a value indicating whether the BackColor property has been initialized or not.

Declaration
public bool HasBackColor { get; }
Property Value
Type
System.Boolean

HasCommentArrowColor

Gets a value indicating whether the CommentArrowColor property has been initialized or not.

Declaration
public bool HasCommentArrowColor { get; }
Property Value
Type
System.Boolean

HasCommentArrowSize

Gets a value indicating whether the CommentArrowSize property has been initialized or not.

Declaration
public bool HasCommentArrowSize { get; }
Property Value
Type
System.Boolean

HasCommentFont

Gets a value indicating whether the CommentFont property has been initialized or not.

Declaration
public bool HasCommentFont { get; }
Property Value
Type
System.Boolean

HasCommentImage

Gets a value indicating whether the CommentImage property has been initialized or not.

Declaration
public bool HasCommentImage { get; }
Property Value
Type
System.Boolean

HasCommentIndicatorColor

Gets a value indicating whether the CommentIndicatorColor property has been initialized or not.

Declaration
public bool HasCommentIndicatorColor { get; }
Property Value
Type
System.Boolean

HasCommentIndicatorSize

Gets a value indicating whether the CommentIndicatorSize property has been initialized or not.

Declaration
public bool HasCommentIndicatorSize { get; }
Property Value
Type
System.Boolean

HasCommentText

Gets a value indicating whether the CommentText property has been initialized or not.

Declaration
public bool HasCommentText { get; }
Property Value
Type
System.Boolean

HasCommentWindowSize

Gets a value indicating whether the CommentWindowSize property has been initialized or not.

Declaration
public bool HasCommentWindowSize { get; }
Property Value
Type
System.Boolean

HasForeColor

Gets a value indicating whether the ForeColor property has been initialized or not.

Declaration
public bool HasForeColor { get; }
Property Value
Type
System.Boolean

Methods

GetDefaultStyle()

Gets the default CommentTip values.

Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type Description
StyleInfoBase

Returns the default values for the GridCommentTipInfo property.
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

Copy of current object.
Overrides

ResetBackColor()

Resets the value for the BackColor property.

Declaration
public void ResetBackColor()

ResetCommentArrowColor()

Resets the value for the CommentArrowColor property.

Declaration
public void ResetCommentArrowColor()

ResetCommentArrowSize()

Resets the CommentArrowSize property.

Declaration
public void ResetCommentArrowSize()

ResetCommentFont()

Resets the value for the CommentFont property.

Declaration
public void ResetCommentFont()

ResetCommentImage()

Resets the CommentImage property.

Declaration
public void ResetCommentImage()

ResetCommentIndicatorColor()

Resets the CommentIndicatorColor property.

Declaration
public void ResetCommentIndicatorColor()

ResetCommentIndicatorSize()

Resets the CommentIndicatorSize property.

Declaration
public void ResetCommentIndicatorSize()

ResetCommentInidcatorColor()

Resets the CommentIndicatorColor property.

Declaration
[Obsolete("Use ResetCommentIndicatorColor method instead")]
public void ResetCommentInidcatorColor()

ResetCommentInidcatorSize()

Resets the CommentIndicatorSize property.

Declaration
[Obsolete("Use ResetCommentIndicatorSize method instead")]
public void ResetCommentInidcatorSize()

ResetCommentText()

Resets the CommentText property.

Declaration
public void ResetCommentText()

ResetCommentWindowSize()

Resets the CommentWindowSize property.

Declaration
public void ResetCommentWindowSize()

ResetForeColor()

Reset the value for the ForeColor property.

Declaration
public void ResetForeColor()

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable