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
Implements
Inherited Members
Namespace: Syncfusion.GridHelperClasses
Assembly: Syncfusion.GridHelperClasses.Windows.dll
Syntax
public class ButtonEditInfo : GridStyleInfoSubObject, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObjectConstructors
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 |
|---|
| 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 |
|---|
| 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:
| Property | Value |
|---|---|
| IsLeft | False |
| ButtonEditType | ButtonEditType.Browse |
| Width | 20 |
| Text | "" |
| TextColor | Color.Black |
| BackColor | Control.DefaultBackColor |
| Enabled | True |
| Image | null |
Enabled
Gets or sets a value indicating whether the button should be enabled.
Declaration
public bool Enabled { get; set; }Property Value
| Type |
|---|
| 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 |
|---|
| 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 |
|---|
| 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 |
|---|
| System.Boolean |
Text
Gets or sets the text to be shown in the button.
Declaration
public string Text { get; set; }Property Value
| Type |
|---|
| System.String |
TextColor
Gets or sets the text color.
Declaration
public Color TextColor { get; set; }Property Value
| Type |
|---|
| 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 |
|---|
| 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
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
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 |