Click or drag to resize

Command Class

Inheritance Hierarchy

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

The Command type exposes the following members.

Constructors
  NameDescription
Public methodCommand
Initializes a new instance of the Command class
Public methodCommand(String)
Initializes a new instance of the Command class
Top
Properties
  NameDescription
Public propertyActionsClickEventHandler
Public propertyEnabledScript
A JavaScript snippet that specifies whether this button is enabled or not. If this member contains a value, the result / value of the 'EnabledExpression' is ignored.
(Overrides RibbonButtonConfigurationEnabledScript.)
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.
(Inherited from RibbonButtonConfiguration.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString (Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
Public fieldClickEventHandler (Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
Public fieldIconUrl
Specifies the standard icon for the ribbon button.
(Inherited from RibbonButtonConfiguration.)
Public fieldId
Public fieldLabel
Specifies the title for the ribbon button.
(Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
Public fieldLargeIconUrl
Specifies the large icon for the ribbon button.
(Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
Public fieldOpenInDialog
Specifies whether to open the provided URI within a dialog.
(Inherited from RibbonButtonConfiguration.)
Public fieldTemplateAlias (Inherited from RibbonButtonConfiguration.)
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.
(Inherited from RibbonButtonConfiguration.)
Top
Remarks
This is a MatchPoint configuration class.
See Also