BarSplitButtonLink Class
Represents a bar split button command link.
[TypeConverter(typeof(BarSplitButtonLinkConverter))]
public class BarSplitButtonLink : BarCommandLink, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IImageListProvider, IBarPopupCommandLink- Inheritance:
- object MarshalByRefObject DisposableObject LogicalTreeNodeBase UIElement BarCommandLink object
- Implements:
- IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IImageListProvider IBarPopupCommandLink
Constructors
BarSplitButtonLink(BarSplitButtonCommand)
Initializes a new instance of the BarSplitButtonLink class.
public BarSplitButtonLink(BarSplitButtonCommand command)| Parameter | Type | Description |
|---|---|---|
| command | BarSplitButtonCommand | The BarCommand upon which the link is based. |
BarSplitButtonLink(string, string, string, int, bool, bool, bool, bool)
Initializes a new instance of the BarSplitButtonLink class, for use in a programmatically created popup menu.
public BarSplitButtonLink(string category, string name, string text, int imageIndex, bool enabled, bool checkable, bool isChecked, bool beginAGroup)| 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. |
| beginAGroup | bool | Whether to begin a group. |
Properties
Command
Gets the BarSplitButtonCommand to link to.
[Browsable(false)]
public BarSplitButtonCommand Command { get; }Property Value
- BarSplitButtonCommand:
The BarSplitButtonCommand to link to.
CommandLinks
Gets the BarCommandLinkCollection containing the command links for use in the button's popup.
[Browsable(false)]
public BarCommandLinkCollection CommandLinks { get; }Property Value
- BarCommandLinkCollection:
The BarCommandLinkCollection containing the command links for use in the button's popup.
UseToolBarStyleForPopupMenu
Gets or sets whether to display the popup menu using a toolbar style.
public DefaultableBoolean UseToolBarStyleForPopupMenu { get; set; }Property Value
- DefaultableBoolean:
A DefaultableBoolean that indicates if a toolbar style should be used.
Remarks
If set to DefaultableBoolean.Default, the resolved value will use the command's setting.
Methods
Clone()
Creates a copy of the BarCommandLink.
GetButtonDrawState()
Gets the UIElementDrawState for the element.
public UIElementDrawState GetButtonDrawState()Returns
- UIElementDrawState:
The UIElementDrawState for the element.
Remarks
The default implementation of this method returns UIElementDrawState.None.
GetPopupDrawState()
Gets the UIElementDrawState for the element.
public UIElementDrawState GetPopupDrawState()Returns
- UIElementDrawState:
The UIElementDrawState for the element.
Remarks
The default implementation of this method returns UIElementDrawState.None.
IsDifferentFromDefault(BarCommandLink)
Returns whether the command link is different from the specified BarCommandLink.
protected override bool IsDifferentFromDefault(BarCommandLink defaultCommandLink)| Parameter | Type | Description |
|---|---|---|
| defaultCommandLink | BarCommandLink | The BarCommandLink to examine. |
Returns
- bool:
true if the command link is different from the specified BarCommandLink.
OnMouseDown(MouseEventArgs)
Raises the MouseDown event.
protected override void OnMouseDown(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A |
OnMouseEnter(MouseEventArgs)
Raises the MouseEnter event.
protected override void OnMouseEnter(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A |
OnMouseUp(MouseEventArgs)
Raises the MouseUp event.
protected override void OnMouseUp(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A |
OnRender(PaintEventArgs)
Renders the element.
protected override void OnRender(PaintEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | PaintEventArgs | A PaintEventArgs that contains the event data. |
Process(BarProcessEventArgs)
Performs processing based on some sort of event.
protected override void Process(BarProcessEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | BarProcessEventArgs | 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. |
ResetUseToolBarStyleForPopupMenu()
Resets the UseToolBarStyleForPopupMenu property to its default value.
public virtual void ResetUseToolBarStyleForPopupMenu()ShouldSerializeUseToolBarStyleForPopupMenu()
Indicates whether the UseToolBarStyleForPopupMenu property should be persisted.
public virtual bool ShouldSerializeUseToolBarStyleForPopupMenu()Returns
- bool:
trueif the property value has changed from its default; otherwise,false.
WriteAttributesToXml(BarLayoutXmlSerializer, BarCommandLink)
Serializes the attribute data for the BarCommandLink to XML.
protected override void WriteAttributesToXml(BarLayoutXmlSerializer serializer, BarCommandLink defaultCommandLink)| Parameter | Type | Description |
|---|---|---|
| serializer | BarLayoutXmlSerializer | The BarLayoutXmlSerializer to use. |
| defaultCommandLink | BarCommandLink | The default BarCommandLink that is used for differential layout comparison. |
WriteElementsToXml(BarLayoutXmlSerializer, BarCommandLink)
Serializes the child element data for the BarCommandLink to XML.
protected override void WriteElementsToXml(BarLayoutXmlSerializer serializer, BarCommandLink defaultCommandLink)| Parameter | Type | Description |
|---|---|---|
| serializer | BarLayoutXmlSerializer | The BarLayoutXmlSerializer to use. |
| defaultCommandLink | BarCommandLink | The default BarCommandLink that is used for differential layout comparison. |
Inherited Members
- BarCommandLink.ResetBeginAGroup()
- BarCommandLink.ShouldSerializeBeginAGroup()
- BarCommandLink.ResetDefaultImage()
- BarCommandLink.ShouldSerializeDefaultImage()
- BarCommandLink.ResetDefaultText()
- BarCommandLink.ShouldSerializeDefaultText()
- BarCommandLink.ResetDisplayStyle()
- BarCommandLink.ShouldSerializeDisplayStyle()
- BarCommandLink.ResetEnabled()
- BarCommandLink.ShouldSerializeEnabled()
- BarCommandLink.GetEnabled()
- BarCommandLink.GetImage()
- BarCommandLink.GetImageSize()
- BarCommandLink.GetMnemonic()
- BarCommandLink.GetText()
- BarCommandLink.GetToolTipText()
- BarCommandLink.ResetImage()
- BarCommandLink.ShouldSerializeImage()
- BarCommandLink.ResetImageIndex()
- BarCommandLink.ShouldSerializeImageIndex()
- BarCommandLink.MeasureOverride(Graphics, Size)
- BarCommandLink.ResetMergeAction()
- BarCommandLink.ShouldSerializeMergeAction()
- BarCommandLink.ResetMergeKey()
- BarCommandLink.ShouldSerializeMergeKey()
- BarCommandLink.OnEnabledChanged(EventArgs)
- BarCommandLink.OnMouseLeave(MouseEventArgs)
- BarCommandLink.OnIsSelectedChanged(EventArgs)
- BarCommandLink.OnParentChanged()
- BarCommandLink.ProcessKeyDown(Keys)
- BarCommandLink.ShouldDisplayImage()
- BarCommandLink.ShouldDisplayText()
- BarCommandLink.ResetText()
- BarCommandLink.ShouldSerializeText()
- BarCommandLink.ResetVisible()
- BarCommandLink.ShouldSerializeVisible()
- BarCommandLink.BarControl
- BarCommandLink.BeginAGroup
- BarCommandLink.CommandCore
- BarCommandLink.DefaultImage
- BarCommandLink.DefaultText
- BarCommandLink.DisplayStyle
- BarCommandLink.Enabled
- BarCommandLink.HasImage
- BarCommandLink.Image
- BarCommandLink.ImageIndex
- BarCommandLink.InvalidateOnMouseEvents
- BarCommandLink.IsClickableInCustomizeMode
- BarCommandLink.IsMergeModified
- BarCommandLink.IsSelected
- BarCommandLink.MergeAction
- BarCommandLink.MergeKey
- BarCommandLink.Mnemonic
- BarCommandLink.ScreenBounds
- BarCommandLink.Tag
- BarCommandLink.Text
- BarCommandLink.Visible
- BarCommandLink.VisibleCore
- UIElement.logger
- UIElement.Dispose(bool)
- UIElement.AddPendingGraphicsInversion(Rectangle)
- UIElement.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIElement.AddPendingScrollOperation(Rectangle, int, int)
- UIElement.Arrange(Rectangle)
- UIElement.ArrangeOverride(Size)
- UIElement.CaptureMouse()
- UIElement.ContainsLocation(Point)
- UIElement.CreateGraphics()
- UIElement.DpiScaleChanged(SizeF)
- UIElement.GetCursor(Point)
- UIElement.Invalidate()
- UIElement.Invalidate(Rectangle)
- UIElement.Invalidate(InvalidationLevels, InvalidationTypes)
- UIElement.InvalidateArrange()
- UIElement.InvalidateMeasure()
- UIElement.Measure(Graphics, Size)
- UIElement.OnClick(MouseEventArgs)
- UIElement.OnDoubleClick(MouseEventArgs)
- UIElement.OnMouseCaptureLost(EventArgs)
- UIElement.OnMouseHover(MouseEventArgs)
- UIElement.OnMouseMove(MouseEventArgs)
- UIElement.OnMouseWheel(MouseEventArgs)
- UIElement.OnRenderChildElements(PaintEventArgs)
- UIElement.OnResize(EventArgs)
- UIElement.PostArrangeOverride()
- UIElement.ReleaseMouseCapture()
- UIElement.Render(PaintEventArgs)
- UIElement.TransformToAncestor(IUIElement)
- UIElement.TransformToDescendant(IUIElement)
- UIElement.UpdateLayout()
- UIElement.ActualHeight
- UIElement.ActualWidth
- UIElement.Bounds
- UIElement.CaptureMouseWhenPressed
- UIElement.ClipBounds
- UIElement.DesiredSize
- UIElement.DpiScaleFactor
- UIElement.IsArrangeValid
- UIElement.IsMeasureValid
- UIElement.IsMouseCaptured
- UIElement.IsRightToLeft
- UIElement.Size
- UIElement.VisualOffset
- UIElement.Click
- UIElement.DoubleClick
- UIElement.MouseCaptureLost
- UIElement.MouseDown
- UIElement.MouseEnter
- UIElement.MouseHover
- UIElement.MouseLeave
- UIElement.MouseMove
- UIElement.MouseUp
- UIElement.MouseWheel
- UIElement.Resize
- LogicalTreeNodeBase.CreateChildren()
- DisposableObject.Dispose()
- DisposableObject.VerifyNotDisposed()
- DisposableObject.IsDisposed
- DisposableObject.Disposed
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()