Click or drag to resize

RibbonButtonConfiguration Class

Configuration class for a ribbon button.
Inheritance Hierarchy
SystemObject
  Colygon.MatchPoint.Core.WebPartsRibbonButtonConfiguration
    Colygon.MatchPoint.Core.WebPartsCommand

Namespace:  Colygon.MatchPoint.Core.WebParts
Assembly:  Colygon.MatchPoint (in Colygon.MatchPoint.dll) Version: 2019.2.1.0
Syntax
C#
[SerializableAttribute]
public class RibbonButtonConfiguration

The RibbonButtonConfiguration type exposes the following members.

Constructors
  NameDescription
Public methodRibbonButtonConfiguration
Initializes a new instance of the RibbonButtonConfiguration class
Top
Properties
  NameDescription
Public propertyEnabledScript
A JavaScript snippet that specifies whether this button is enabled or not.
Public propertyOnClickExpression
Specifies an expression that is evaluated when the button is clicked. You can use the ConnectionData expression variable to access the currently selected element from the parent Web Part.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGenerateClientScript
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformClick
Public methodToString (Overrides ObjectToString.)
Top
Fields
  NameDescription
Public fieldActions
Contains actions that are executed when the user clicks the button. A post-back will be executed if buttons are configured regardless of the setting 'DoPostBack'. The evaluation result of 'OnClickExpression' will be associated with the workflow. This can be a string representing an URL to a Workspace or SP list item or an object that can be casted to IUpdatable.
Public fieldClickEventHandler
Public fieldDoPostBack
Specifies whether a postback is executed when the button is clicked. If there are 'Actions' defined, this setting will be ignored and a post-back will be executed.
Public fieldEnabledExpression
Specifies whether this button is visible/enabled or not. An expression can be used to determine the visibility dynamically. This expression is expected to return a Boolean value.
Public fieldIconOffsetLeft
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.
Public fieldIconOffsetTop
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.
Public fieldIconUrl
Specifies the standard icon for the ribbon button.
Public fieldLabel
Specifies the title for the ribbon button.
Public fieldLargeIconOffsetLeft
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.
Public fieldLargeIconOffsetTop
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.
Public fieldLargeIconUrl
Specifies the large icon for the ribbon button.
Public fieldOnClickScript
Specifies a javascript call that is executed if the button is clicked. You can use the ConnectionData expression variable to access the currently selected element from the parent Web Part. You can use the JavaScript variable 'resultValue' to access the evaluation result of the 'OnClickExpression', if 'DoPostBack' is disabled. Return 'true' in order to refresh the parent control.
Public fieldOpenInDialog
Specifies whether to open the provided URI within a dialog.
Public fieldTemplateAlias
Public fieldUrl
Specifies the URL that should be opened if the button is clicked. You can use the ConnectionData expression variable to access the currently selected element from the parent Web Part.
Top
Remarks
This is a MatchPoint configuration class.
See Also