WinForms

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

    Show / Hide Table of Contents

    Class ButtonEditInfo

    Provides a GridStyleInfoSubObject object for button edit 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
    GridStyleInfoSubObject
    ButtonEditInfo
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    IStyleInfoSubObject
    Inherited Members
    GridStyleInfoSubObject.GetGridStyleInfo()
    GridStyleInfoSubObject.GetCellIdentity()
    GridStyleInfoSubObject.GetGridModel()
    GridStyleInfoSubObject.GetActiveGridView()
    GridStyleInfoSubObject.ToString()
    GridStyleInfoSubObject.Info
    StyleInfoSubObjectBase.Dispose(Boolean)
    StyleInfoSubObjectBase.IntGetDefaultStyleInfo(StyleInfoProperty)
    StyleInfoSubObjectBase.SubObjectIdentity
    StyleInfoSubObjectBase.Sip
    StyleInfoSubObjectBase.Data
    StyleInfoSubObjectBase.Owner
    StyleInfoBase.WriteXml(XmlWriter)
    StyleInfoBase.ReadXml(XmlReader)
    StyleInfoBase.SetStore(StyleInfoStore)
    StyleInfoBase.ClearCache()
    StyleInfoBase.Dispose()
    StyleInfoBase.Equals(Object)
    StyleInfoBase.EqualsObject(Object, Object)
    StyleInfoBase.GetHashCode()
    StyleInfoBase.ToString(String)
    StyleInfoBase.ToString(String, IFormatProvider)
    StyleInfoBase.ParseString(String)
    StyleInfoBase.BeginInit()
    StyleInfoBase.EndInit()
    StyleInfoBase.BeginUpdate()
    StyleInfoBase.EndUpdate()
    StyleInfoBase.CreateSubObjectIdentity(StyleInfoProperty)
    StyleInfoBase.GetDefaultStyleInfoStore(StyleInfoProperty)
    StyleInfoBase.OnStyleChanging(StyleInfoProperty)
    StyleInfoBase.IsSubset(IStyleInfo)
    StyleInfoBase.CopyFrom(IStyleInfo)
    StyleInfoBase.ModifyStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.InheritStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.MergeStyle(IStyleInfo)
    StyleInfoBase.HasValue(StyleInfoProperty)
    StyleInfoBase.IsValueModified(StyleInfoProperty)
    StyleInfoBase.ResetValue(StyleInfoProperty)
    StyleInfoBase.GetValue(StyleInfoProperty)
    StyleInfoBase.GetDefaultValue(StyleInfoProperty)
    StyleInfoBase.GetShortValue(StyleInfoProperty)
    StyleInfoBase.SetValue(StyleInfoProperty, Object)
    StyleInfoBase.SetValue(StyleInfoProperty, Int16)
    StyleInfoBase.IConvertible.ToUInt64(IFormatProvider)
    StyleInfoBase.IConvertible.ToSByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToDouble(IFormatProvider)
    StyleInfoBase.IConvertible.ToDateTime(IFormatProvider)
    StyleInfoBase.IConvertible.ToSingle(IFormatProvider)
    StyleInfoBase.IConvertible.ToBoolean(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt32(IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToString(IFormatProvider)
    StyleInfoBase.IConvertible.ToByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToChar(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt64(IFormatProvider)
    StyleInfoBase.IConvertible.GetTypeCode()
    StyleInfoBase.IConvertible.ToDecimal(IFormatProvider)
    StyleInfoBase.IConvertible.ToType(Type, IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt32(IFormatProvider)
    StyleInfoBase.Identity
    StyleInfoBase.Store
    StyleInfoBase.CacheValues
    StyleInfoBase.WeakReferenceChangedListeners
    StyleInfoBase.Updating
    StyleInfoBase.IsEmpty
    StyleInfoBase.IsChanged
    StyleInfoBase.Changed
    StyleInfoBase.Changing
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.GridHelperClasses
    Assembly: Syncfusion.GridHelperClasses.Windows.dll
    Syntax
    public class ButtonEditInfo : GridStyleInfoSubObject, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

    Constructors

    ButtonEditInfo()

    Initializes a new instance of the ButtonEditInfo class.

    Declaration
    public ButtonEditInfo()

    ButtonEditInfo(StyleInfoSubObjectIdentity)

    Initializes a new instance of the ButtonEditInfo class and associates it with an existing GridStyleInfoSubObjectIdentity.

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

    A StyleInfoSubObjectIdentity that holds the identity for this ButtonEditInfo.

    ButtonEditInfo(StyleInfoSubObjectIdentity, ButtonEditInfoStore)

    Initializes a new ButtonEditInfo object and associates it with an existing StyleInfoSubObjectIdentity .

    Declaration
    public ButtonEditInfo(StyleInfoSubObjectIdentity identity, ButtonEditInfoStore store)
    Parameters
    Type Name Description
    StyleInfoSubObjectIdentity identity

    A StyleInfoSubObjectIdentity that holds the identity for this GridFontInfo

    ButtonEditInfoStore store

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

    ButtonEditInfo(Font)

    Initializes a new ButtonEditInfo object and initializes its IsLeft, ButtonEditType, Width, Text, TextColor, Enabled and BackColor properties

    Declaration
    public ButtonEditInfo(Font font)
    Parameters
    Type Name Description
    System.Drawing.Font font

    Cell font.

    Properties

    BackColor

    Gets or sets the BackColor of the button.

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

    ButtonEditType

    Gets or sets the type of the Image to be drawn in the button.

    Declaration
    public ButtonType ButtonEditType { get; set; }
    Property Value
    Type Description
    ButtonType

    Default

    Gets a default ButtonEditInfo to be used with a default style.

    Declaration
    public static ButtonEditInfo Default { get; }
    Property Value
    Type Description
    ButtonEditInfo

    The default.

    Remarks

    Default settings are:

    PropertyValue
    IsLeftFalse
    ButtonEditTypeButtonEditType.Browse
    Width20
    Text""
    TextColorColor.Black
    BackColorControl.DefaultBackColor
    EnabledTrue
    Imagenull

    Enabled

    Gets or sets a value indicating whether the button should be enabled.

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    ForceBackColor

    Gets or sets a value indicating whether the button should be colored with the BackColor if themes are enabled

    Declaration
    public bool ForceBackColor { get; set; }
    Property Value
    Type Description
    System.Boolean

    HorizontalAlignment

    Gets or sets the horizontal alignment.

    Declaration
    public GridHorizontalAlignment HorizontalAlignment { get; set; }
    Property Value
    Type Description
    GridHorizontalAlignment

    The horizontal alignment.

    Image

    Gets or sets the Image to be displayed in the button.

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

    IsLeft

    Gets or sets a value indicating whether the button should be positioned in the left side of the cell.

    Declaration
    public bool IsLeft { get; set; }
    Property Value
    Type Description
    System.Boolean

    Text

    Gets or sets the text to be shown in the button.

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

    TextColor

    Gets or sets the text color.

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

    VerticalAlignment

    Gets or sets the vertical alignment.

    Declaration
    public GridVerticalAlignment VerticalAlignment { get; set; }
    Property Value
    Type Description
    GridVerticalAlignment

    The vertical alignment.

    Width

    Gets or sets the width of the button.

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

    Methods

    GetDefaultStyle()

    Gets the default style object by override this method for your derived class.

    Declaration
    protected override StyleInfoBase GetDefaultStyle()
    Returns
    Type Description
    StyleInfoBase

    A default style object.

    Overrides
    StyleInfoBase.GetDefaultStyle()

    MakeCopy(StyleInfoBase, StyleInfoProperty)

    Gets a 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 current object.

    Overrides
    StyleInfoSubObjectBase.MakeCopy(StyleInfoBase, StyleInfoProperty)

    OnStyleChanged(StyleInfoProperty)

    Overrides the method OnStyleChanged for your derived class.

    Declaration
    protected override void OnStyleChanged(StyleInfoProperty sip)
    Parameters
    Type Name Description
    StyleInfoProperty sip

    The style info property

    Overrides
    StyleInfoSubObjectBase.OnStyleChanged(StyleInfoProperty)

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    IStyleInfoSubObject
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved