BarSplitButtonCommand Class
Represents a bar button command with a split drop-down.
public class BarSplitButtonCommand : BarCommand, IImageListProvider, IBarCheckableCommand, IBarPopupCommand, IHasDefaultCommandLinks
- Inheritance:
- object Command BarCommand object
Constructors
BarSplitButtonCommand(string, string, string, int)
Initializes a new instance of the BarSplitButtonCommand
class.
public BarSplitButtonCommand(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 |
BarSplitButtonCommand(string, string, string, int, bool, bool, bool)
Initializes a new instance of the BarSplitButtonCommand
class.
public BarSplitButtonCommand(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
CanTearOff
Gets or sets whether the popup menu can be torn-off onto a DockableToolBar.
public bool CanTearOff { get; set; }
Property Value
- bool:
true
if the popup menu can be torn-off onto a DockableToolBar; otherwise,false
.
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
.
DefaultCommandLinks
Gets the BarCommandLinkCollection containing the default command links for use in the button's popup.
public BarCommandLinkCollection DefaultCommandLinks { get; }
Property Value
- BarCommandLinkCollection:
The BarCommandLinkCollection containing the default command links for use in the button's popup.
TearOffDockableToolBarKey
Gets or sets the key of the DockableToolBar that is created if a tear-off occurs.
public string TearOffDockableToolBarKey { get; set; }
Property Value
- string:
The key of the DockableToolBar that is created if a tear-off occurs.
UseToolBarStyleForPopupMenu
Gets or sets whether to display the popup menu using a toolbar style.
public bool UseToolBarStyleForPopupMenu { get; set; }
Property Value
- bool:
true
if a toolbar style should be used; 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 |
Process(BarProcessEventArgs)
Performs processing based on some sort of event.
protected override void Process(BarProcessEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarProcessEventArgs | 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. |
ReadElementFromXml(BarLayoutXmlSerializer)
Deserializes a child element for the BarCommandLink from XML.
protected override void ReadElementFromXml(BarLayoutXmlSerializer serializer)
Parameter | Type | Description |
---|---|---|
serializer | BarLayoutXmlSerializer | The BarLayoutXmlSerializer to use. |
ResetCanCustomizeKeyboardShortcuts()
Resets the CanCustomizeKeyboardShortcuts property to its default value.
public override void ResetCanCustomizeKeyboardShortcuts()
ResetCanTearOff()
Resets the CanTearOff property to its default value.
public virtual void ResetCanTearOff()
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()
ResetTearOffDockableToolBarKey()
Resets the TearOffDockableToolBarKey property to its default value.
public virtual void ResetTearOffDockableToolBarKey()
ResetUseToolBarStyleForPopupMenu()
Resets the UseToolBarStyleForPopupMenu property to its default value.
public virtual void ResetUseToolBarStyleForPopupMenu()
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
.
ShouldSerializeCanTearOff()
Indicates whether the CanTearOff property should be persisted.
public virtual bool ShouldSerializeCanTearOff()
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
.
ShouldSerializeTearOffDockableToolBarKey()
Indicates whether the TearOffDockableToolBarKey property should be persisted.
public virtual bool ShouldSerializeTearOffDockableToolBarKey()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeUseToolBarStyleForPopupMenu()
Indicates whether the UseToolBarStyleForPopupMenu property should be persisted.
public virtual bool ShouldSerializeUseToolBarStyleForPopupMenu()
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. |
WriteElementsToXml(BarLayoutXmlSerializer)
Serializes the child element data for the BarCommand to XML.
protected override void WriteElementsToXml(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.ResetStaysOpenOnClick()
- BarCommand.ShouldSerializeStaysOpenOnClick()
- BarCommand.ResetText()
- BarCommand.ShouldSerializeText()
- BarCommand.ResetToolTipEnabled()
- BarCommand.ShouldSerializeToolTipEnabled()
- BarCommand.ResetToolTipText()
- BarCommand.ShouldSerializeToolTipText()
- BarCommand.UpdateState(BarCommandLinkEventArgs)
- 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()