RibbonButton Class

Specifies a push button control.

Inheritance Hierarchy

SystemObject
  Colygon.MatchPoint.Common.RibbonRibbonElement
    Colygon.MatchPoint.Common.RibbonRibbonControl
      Colygon.MatchPoint.Common.RibbonRibbonButton
        Colygon.MatchPoint.Common.RibbonRibbonToggleButton

Namespace: Colygon.MatchPoint.Common.Ribbon
Assembly: Colygon.MatchPoint (in Colygon.MatchPoint.dll) Version: 2019.2.1.0

Syntax

Copy

public class RibbonButton : RibbonControl

The RibbonButton type exposes the following members.

Constructors

	Name	Description
	RibbonButton	Initializes a new RibbonButton instance.
	RibbonButton(String, String, String)	Initializes a new instance of the RibbonButton class
	RibbonButton(String, String, String, EventHandler)	Initializes a new instance of the RibbonButton class
	RibbonButton(String, String, String, String)	Initializes a new instance of the RibbonButton class

Top

Properties

	Name	Description
	CommandProvider	The RibbonCommandProvider providing functionality for this ribbon element. (Inherited from RibbonElement.)
	Enabled	Specifies whether the button control is displayed as enabled.
	Id	A string that identifies this element, such as "Ribbon.Library.Share.NewRibbonButton". (Inherited from RibbonElement.)
	Parent	Specifies the parent element. (Inherited from RibbonElement.)
	UniqueId	A string that identifies this element. (Inherited from RibbonElement.)

Top

Methods

	Name	Description
	AddConnectionDependencies	(Overrides RibbonElementAddConnectionDependencies(DependencyCollection).)
	BuildOpenScript
	Button_Click
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformClick	Executes the Click-EventHandler.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToXml	Serializes this ribbon element to XML. (Inherited from RibbonElement.)
	ToXml(XmlTextWriter)	(Overrides RibbonElementToXml(XmlTextWriter).)
	WriteAttributes

Top

Events

	Name	Description
	Click	Specifies the button click event handler.

Top

Fields

	Name	Description
	EnabledExpression	Specifies an expression that determines whether the button control is displayed as enabled. The expression is expected to return a Boolean value.
	EnabledScript	Specifies a JavaScript method that determines whether the button control is displayed as enabled. The script is expected to return a Boolean value.
	IconOffsetLeft	A negative integer that represents an offset for the left edge of the image. Use this attribute when the 'IconUrl' attribute points to an image file that contains the images for many icons. The value is used to set the CSS top attribute for the inline style of an HTML img tag.
	IconOffsetTop	A negative integer that represents an offset for the top edge of the image. Use this attribute when the 'IconUrl' attribute points to an image file that contains the images for many icons. The value is used to set the CSS top attribute for the inline style of an HTML img tag.
	IconUrl	Specifies the URL of an image displayed on the button if it is displayed small. This image should be 16x16 pixels.
	Label	Specifies the button label.
	LargeIconOffsetLeft	A negative integer that represents an offset for the left edge of the image. Use this attribute when the 'LargeIconUrl' attribute points to an image file that contains the images for many icons. The value is used to set the CSS top attribute for the inline style of an HTML img tag.
	LargeIconOffsetTop	A negative integer that represents an offset for the top edge of the image. Use this attribute when the 'LargeIconUrl' attribute points to an image file that contains the images for many icons. The value is used to set the CSS top attribute for the inline style of an HTML img tag.
	LargeIconUrl	Specifies the URL of an image displayed on the button if it is displayed large. This image should be 32x32 pixels.
	OnClientClick	Specifies the client sided on click behavior.
	Sequence	An integer that specifies the order of placement among sibling XML nodes (Inherited from RibbonElement.)
	TemplateAlias
	Visible	Specifies whether the element is visible. (Inherited from RibbonElement.)

Top

Reference

Colygon.MatchPoint.Common.Ribbon Namespace