WinForms

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

    Show / Hide Table of Contents

    Class CaptionButton

    The CaptionButton class which contains the required details.

    Inheritance
    System.Object
    CaptionButton
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class CaptionButton

    Constructors

    CaptionButton()

    Constructor of the CaptionButton.

    Declaration
    public CaptionButton()

    CaptionButton(CaptionButtonType)

    Constructor of the CaptionButton.

    Declaration
    public CaptionButton(CaptionButtonType type)
    Parameters
    Type Name Description
    CaptionButtonType type

    The Caption button type.

    CaptionButton(CaptionButtonType, String)

    Constructor of the CaptionButton.

    Declaration
    public CaptionButton(CaptionButtonType type, string name)
    Parameters
    Type Name Description
    CaptionButtonType type

    The Caption button type.

    System.String name

    The name of the caption button.

    CaptionButton(CaptionButtonType, String, Int32, Color, String)

    Constructor of the CaptionButton.

    Declaration
    public CaptionButton(CaptionButtonType type, string name, int imageIndex, Color clr, string tooltip)
    Parameters
    Type Name Description
    CaptionButtonType type

    The CaptionButtonType.

    System.String name

    The name of the Caption button.

    System.Int32 imageIndex

    The index of the image.

    System.Drawing.Color clr

    The color

    System.String tooltip

    The ToolTip of the caption button

    Fields

    m_bModified

    Declaration
    protected bool m_bModified
    Field Value
    Type Description
    System.Boolean

    m_cbtType

    Declaration
    protected CaptionButtonType m_cbtType
    Field Value
    Type Description
    CaptionButtonType

    m_clTransparentImage

    Declaration
    protected Color m_clTransparentImage
    Field Value
    Type Description
    System.Drawing.Color

    m_ImageIndex

    Declaration
    protected int m_ImageIndex
    Field Value
    Type Description
    System.Int32

    m_name

    Declaration
    protected string m_name
    Field Value
    Type Description
    System.String

    m_ToolTip

    Declaration
    protected string m_ToolTip
    Field Value
    Type Description
    System.String

    m_toolTipInfo

    Declaration
    protected ToolTipInfo m_toolTipInfo
    Field Value
    Type Description
    ToolTipInfo

    Properties

    ImageIndex

    Indicates index of image to use when displaying this button. External ImageList should be used.

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

    Modified

    Declaration
    protected bool Modified { get; set; }
    Property Value
    Type Description
    System.Boolean

    Name

    Gets/Sets the name of this button.

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

    SuperToolTipInfo

    Gets / sets customizable SuperToolTip drawing info used by the caption button.

    Declaration
    public ToolTipInfo SuperToolTipInfo { get; set; }
    Property Value
    Type Description
    ToolTipInfo

    A ToolTipInfo used to draw supertooltip for current button.

    ToolTip

    Gets/sets text that will be displayed in ToolTip when cursor is over this button.

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

    TransparentImageColor

    Indicates what color in button's image should be transparent.

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

    Type

    Indicates type of this button.

    Declaration
    public CaptionButtonType Type { get; set; }
    Property Value
    Type Description
    CaptionButtonType

    Methods

    Clone()

    Returns the cloned caption button.

    Declaration
    public CaptionButton Clone()
    Returns
    Type Description
    CaptionButton

    FireClickEvent(CancelEventArgs)

    Occurs when caption button captured.

    Declaration
    public void FireClickEvent(CancelEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs e

    HasDefaultValue(CaptionButton)

    Returns the HasDefaultValue

    Declaration
    public static bool HasDefaultValue(CaptionButton button)
    Parameters
    Type Name Description
    CaptionButton button
    Returns
    Type Description
    System.Boolean

    OnClick(CancelEventArgs)

    Declaration
    protected void OnClick(CancelEventArgs args)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs args

    OnRepaint()

    Declaration
    protected void OnRepaint()

    OnTypeChanging(CancelEventArgs)

    Declaration
    protected void OnTypeChanging(CancelEventArgs args)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs args

    Events

    Changed

    Raises when Caption button changed.

    Declaration
    public event EventHandler Changed
    Event Type
    Type Description
    System.EventHandler

    Click

    Raises the click event.

    Declaration
    public event CancelEventHandler Click
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler

    TypeChanging

    Raises when type changing.

    Declaration
    protected event CancelEventHandler TypeChanging
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved