BarButtonCommand Class
Represents a bar button command.
public class BarButtonCommand : BarCommand, IImageListProvider, IBarCheckableCommand
- Inheritance:
- object Command BarCommand object
- Implements:
- IImageListProvider IBarCheckableCommand
Constructors
BarButtonCommand(string, string, string, int)
Initializes a new instance of the BarButtonCommand
class.
public BarButtonCommand(string category, string name, string text, int imageIndex)
Parameter | Type | Description |
---|---|---|
category | string | The category of the bar command. |
name | string | The name of the bar command. |
text | string | The text caption. |
imageIndex | int | The index of an image within an |
BarButtonCommand(string, string, string, int, bool, bool, bool)
Initializes a new instance of the BarButtonCommand
class.
public BarButtonCommand(string category, string name, string text, int imageIndex, bool enabled, bool checkable, bool isChecked)
Parameter | Type | Description |
---|---|---|
category | string | The category of the bar command. |
name | string | The name of the bar command. |
text | string | The text caption. |
imageIndex | int | The index of an image within an |
enabled | bool | Whether the button is enabled. |
checkable | bool | Whether the button is checkable. |
isChecked | bool | Whether the button is currently checked. |
Properties
CheckGroupName
Gets or sets the name of the check group.
Checkable
Gets or sets whether the button is checkable.
public bool Checkable { get; set; }
Property Value
- bool:
true
if the button is checkable; otherwise,false
.
Checked
Gets or sets whether the button is checked.
public bool Checked { get; set; }
Property Value
- bool:
true
if the button is checked; otherwise,false
.
Methods
CloneToType(Type)
Creates a copy of the BarCommand.
protected override BarCommand CloneToType(Type targetType)
Parameter | Type | Description |
---|---|---|
targetType | Type | The target Type. |
Returns
- BarCommand:
The copy of the BarCommand.
CreateCommandLink()
Creates a new BarCommandLink for the command.
public override BarCommandLink CreateCommandLink()
Returns
- BarCommandLink:
The BarCommandLink that was created.
OnClick(BarCommandLinkEventArgs)
Raises the Click
event.
protected virtual void OnClick(BarCommandLinkEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarCommandLinkEventArgs | A |
RaiseClickEvent(BarCommandLinkEventArgs)
Raises the Click
event.
public void RaiseClickEvent(BarCommandLinkEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarCommandLinkEventArgs | A |
ReadAttributesFromXml(BarLayoutXmlSerializer)
Deserializes the attribute data for the BarCommandLink from XML.
protected override void ReadAttributesFromXml(BarLayoutXmlSerializer serializer)
Parameter | Type | Description |
---|---|---|
serializer | BarLayoutXmlSerializer | The BarLayoutXmlSerializer to use. |
ResetCanCustomizeKeyboardShortcuts()
Resets the CanCustomizeKeyboardShortcuts property to its default value.
public override void ResetCanCustomizeKeyboardShortcuts()
ResetCheckGroupName()
Resets the CheckGroupName property to its default value.
public virtual void ResetCheckGroupName()
ResetCheckable()
Resets the Checkable property to its default value.
public virtual void ResetCheckable()
ResetChecked()
Resets the Checked property to its default value.
public virtual void ResetChecked()
ShouldSerializeCanCustomizeKeyboardShortcuts()
Indicates whether the CanCustomizeKeyboardShortcuts property should be persisted.
public override bool ShouldSerializeCanCustomizeKeyboardShortcuts()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeCheckGroupName()
Indicates whether the CheckGroupName property should be persisted.
public virtual bool ShouldSerializeCheckGroupName()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeCheckable()
Indicates whether the Checkable property should be persisted.
public virtual bool ShouldSerializeCheckable()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeChecked()
Indicates whether the Checked property should be persisted.
public virtual bool ShouldSerializeChecked()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
WriteAttributesToXml(BarLayoutXmlSerializer)
Serializes the attribute data for the BarCommand to XML.
protected override void WriteAttributesToXml(BarLayoutXmlSerializer serializer)
Parameter | Type | Description |
---|---|---|
serializer | BarLayoutXmlSerializer | The BarLayoutXmlSerializer to use. |
Events
Click
Occurs when a BarCommand is clicked.
Inherited Members
- BarCommand.ResetCanCustomizeCreate()
- BarCommand.ShouldSerializeCanCustomizeCreate()
- BarCommand.ResetCategory()
- BarCommand.ShouldSerializeCategory()
- BarCommand.ResetCustomizeListText()
- BarCommand.ShouldSerializeCustomizeListText()
- BarCommand.ResetEnabled()
- BarCommand.ShouldSerializeEnabled()
- BarCommand.ResetImage()
- BarCommand.ShouldSerializeImage()
- BarCommand.ResetImageIndex()
- BarCommand.ShouldSerializeImageIndex()
- BarCommand.OnEnabledChanged(EventArgs)
- BarCommand.OnProcessingRequested(BarProcessEventArgs)
- BarCommand.Process(BarProcessEventArgs)
- BarCommand.ReadElementFromXml(BarLayoutXmlSerializer)
- BarCommand.ResetStaysOpenOnClick()
- BarCommand.ShouldSerializeStaysOpenOnClick()
- BarCommand.ResetText()
- BarCommand.ShouldSerializeText()
- BarCommand.ResetToolTipEnabled()
- BarCommand.ShouldSerializeToolTipEnabled()
- BarCommand.ResetToolTipText()
- BarCommand.ShouldSerializeToolTipText()
- BarCommand.UpdateState(BarCommandLinkEventArgs)
- BarCommand.WriteElementsToXml(BarLayoutXmlSerializer)
- BarCommand.BarManager
- BarCommand.CanCustomizeCreate
- BarCommand.CanCustomizeKeyboardShortcuts
- BarCommand.Category
- BarCommand.CustomizeListText
- BarCommand.Enabled
- BarCommand.FullName
- BarCommand.Image
- BarCommand.ImageIndex
- BarCommand.KeyboardShortcuts
- BarCommand.StaysOpenOnClick
- BarCommand.SupportsVerticalDisplay
- BarCommand.Tag
- BarCommand.Text
- BarCommand.ToolTipEnabled
- BarCommand.ToolTipText
- BarCommand.EnabledChanged
- BarCommand.ProcessingRequested
- Command.Name
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()