Table of Contents

Class BasicAction

Namespace
JJMasterData.Core.DataDictionary.Models.Actions
Assembly
JJMasterData.Core.dll

Action basic info

public abstract class BasicAction
Inheritance
BasicAction
Derived
Inherited Members

Constructors

BasicAction() 

public BasicAction()

Properties

Color 

[JsonProperty("color")]
[Display(Name = "Color")]
public BootstrapColor Color { get; set; }

Property Value

BootstrapColor

ConfirmationMessage

If completed when performing the action this message will be displayed with the option (Yes/No) No = Cancels the action Sim = Action will be executed

[JsonProperty("confirmationMessage")]
[Display(Name = "Confirmation Message")]
public string ConfirmationMessage { get; set; }

Property Value

string

CssClass

CSS3 Stylesheet Class

[JsonProperty("cssClass")]
public string CssClass { get; set; }

Property Value

string

DividerLine

Creates a line separator before this action Default = false

[JsonProperty("dividerLine")]
[Display(Name = "Divider Line")]
public bool DividerLine { get; set; }

Property Value

bool

Remarks

Only valid if IsGroup is true.

EnableExpression

Expression that returns a boolean. Operators such as equal symbol and in can be used.

[JsonProperty("enableExpression")]
[Display(Name = "Enable Expression")]
public string EnableExpression { get; set; }

Property Value

string

Examples

EnableExpression

Remarks

See expressions

Icon

Link/Button FontAwesome icon.

[JsonProperty("icon")]
public IconType Icon { get; set; }

Property Value

IconType

IsDefaultOption

Execute this action as default This action will be triggered in any line location

[JsonProperty("isDefaultOption")]
[Display(Name = "Is Default")]
public bool IsDefaultOption { get; set; }

Property Value

bool

IsGroup

Display this action in a group menu Default = false

[JsonProperty("isGroup")]
[Display(Name = "Is Group")]
public bool IsGroup { get; set; }

Property Value

bool

IsUserCreated 

[JsonProperty("isCustomAction")]
public abstract bool IsUserCreated { get; }

Property Value

bool

IsVisible

Verify if the action is static toggled to be hidden.

public bool IsVisible { get; }

Property Value

bool

Location 

[JsonProperty(PropertyName = "formToolbarActionLocation")]
public FormToolbarActionLocation? Location { get; set; }

Property Value

FormToolbarActionLocation?

Name

Identifier of the component

[JsonProperty("name")]
public string Name { get; set; }

Property Value

string

Remarks

IMPORTANT

Don't try to create a action with a repeated name. This can cause unforessen consequences.

Exceptions

ArgumentNullException

Order

Order of the action (0, 1, 2...)

[JsonProperty("order")]
public int Order { get; set; }

Property Value

int

ShowAsButton 

[JsonProperty("showAsButton")]
[Display(Name = "Show as Button")]
public bool ShowAsButton { get; set; }

Property Value

bool

ShowTitle

Display grid title

[JsonProperty("showTitle")]
[Display(Name = "Show Title")]
public bool ShowTitle { get; set; }

Property Value

bool

Text

Action description

[JsonProperty("text")]
public string Text { get; set; }

Property Value

string

Tooltip

Control mouse tooltip

[JsonProperty("tooltip")]
public string Tooltip { get; set; }

Property Value

string

VisibleExpression

Expression that returns a boolean. Operators such as equal symbol and in can be used.

[JsonProperty("visibleExpression")]
[Display(Name = "Visible Expression")]
public string VisibleExpression { get; set; }

Property Value

string

Examples

VisibleExpression

Remarks

See expressions

Methods

DeepCopy() 

public abstract BasicAction DeepCopy()

Returns

BasicAction

SetEnabled(bool)

Set if the action is enabled.

public void SetEnabled(bool value)

Parameters

value bool

SetOptions(BasicAction)

Copy the actions of another action.

public void SetOptions(BasicAction action)

Parameters

action BasicAction

SetVisible(bool)

Set action visibility

public void SetVisible(bool value)

Parameters

value bool
Edit this page