| RibbonToggleButton Class |
Implements functionality for a toggle button displayed within the SharePoint ribbon control.
Inheritance HierarchySystemObject
Colygon.MatchPoint.Common.RibbonRibbonElement
Colygon.MatchPoint.Common.RibbonRibbonControl
Colygon.MatchPoint.Common.RibbonRibbonButton
Colygon.MatchPoint.Common.RibbonRibbonToggleButton
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: 2013.11.0.0
SyntaxC#
public class RibbonToggleButton : RibbonButton
The RibbonToggleButton type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RibbonToggleButton | Initializes a new RibbonToggleButton instance. |
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. (Inherited from RibbonButton.) |
| 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.) |
Methods| Name | Description | |
|---|---|---|
| AddConnectionDependencies | (Inherited from RibbonButton.) |
| 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.
(Inherited from RibbonButton.) |
| 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 RibbonButtonToXml(XmlTextWriter).) |
| WriteAttributes | (Inherited from RibbonButton.) |
Events| Name | Description | |
|---|---|---|
 | Click | Specifies the button click event handler. (Inherited from RibbonButton.) |
Fields| Name | Description | |
|---|---|---|
 | ActiveScript |
Specifies a javascript method that determines whether the button control is displayed as 'toggled' (enabled).
The script is expected to return a Boolean value.
|
| EnabledExpression |
Specifies an expression that determines whether the button control is displayed as enabled. The expression is
expected to return a Boolean value.
(Inherited from RibbonButton.) |
| EnabledScript |
Specifies a JavaScript method that determines whether the button control is displayed as enabled. The script
is expected to return a Boolean value.
(Inherited from RibbonButton.) |
| 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.
(Inherited from RibbonButton.) |
| 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.
(Inherited from RibbonButton.) |
| IconUrl |
Specifies the URL of an image displayed on the button if it is displayed small. This image should be 16x16
pixels.
(Inherited from RibbonButton.) |
| Label | Specifies the button label. (Inherited from RibbonButton.) |
| 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.
(Inherited from RibbonButton.) |
| 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.
(Inherited from RibbonButton.) |
| LargeIconUrl |
Specifies the URL of an image displayed on the button if it is displayed large. This image should be 32x32
pixels.
(Inherited from RibbonButton.) |
| OnClientClick | Specifies the client sided on click behavior. (Inherited from RibbonButton.) |
| Sequence | An integer that specifies the order of placement among sibling XML nodes (Inherited from RibbonElement.) |
| TemplateAlias | (Inherited from RibbonButton.) |
| Visible | Specifies whether the element is visible. (Inherited from RibbonElement.) |
See Also