Interface IToolPlugInRibbonButton

Defines a button to display on the ribbon bar, in the tools area.

Inherited Members
Namespace: Gorgon.Editor.PlugIns
Assembly: Gorgon.Editor.API.dll
Syntax
public interface IToolPlugInRibbonButton : IGorgonNamedObject

Properties

| Edit this page View Source

CanExecute

Property to return the function to determine if the button can be clicked.

Declaration
Func<bool> CanExecute { get; }
Property Value
Type Description
Func<bool>
| Edit this page View Source

ClickCallback

Property to return the action to perform when the button is clicked.

Declaration
Action ClickCallback { get; }
Property Value
Type Description
Action
| Edit this page View Source

Description

Property to set or return the description for the button.

Declaration
string Description { get; set; }
Property Value
Type Description
string
| Edit this page View Source

DisplayText

Property to return the display text for the button.

Declaration
string DisplayText { get; }
Property Value
Type Description
string
| Edit this page View Source

GroupName

Property to return the group that owns this button.

Declaration
string GroupName { get; }
Property Value
Type Description
string
| Edit this page View Source

IsSeparator

Property to return whether this button should start a separator.

Declaration
bool IsSeparator { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsSmall

Property to return whether to use the small icon, or large icon on the ribbon.

Declaration
bool IsSmall { get; }
Property Value
Type Description
bool
| Edit this page View Source

LargeIcon

Property to return the 48x48 large icon.

Declaration
Image LargeIcon { get; }
Property Value
Type Description
Image
| Edit this page View Source

SmallIcon

Property to return the 16x16 small icon.

Declaration
Image SmallIcon { get; }
Property Value
Type Description
Image

Methods

| Edit this page View Source

ValidateButton()

Function to validate the button to ensure it'll be displayed correctly on the ribbon.

Declaration
void ValidateButton()

Extension Methods