Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.ActionItem Class Reference

Action column item definition More...

Inheritance diagram for Ext.Net.ActionItem:
Ext.Net.BaseItem Ext.Net.IXObject Ext.Net.IBase

Classes

class  Builder
 
class  Config
 

Public Member Functions

 ActionItem ()
 
ActionItem.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 ActionItem (Config config)
 
- Public Member Functions inherited from Ext.Net.BaseItem
virtual bool HasExplicitValue (string name)
 
void EnsureDataBind ()
 
virtual void Call (string name)
 
virtual void Call (string name, params object[] args)
 
virtual void AddScript (string script)
 
virtual void AddScript (string script, params object[] args)
 
virtual bool IsEmptyObject ()
 
Apply< T > (IApply config)
 
BaseItem Apply (object config)
 
virtual void LoadViewState (object state)
 
virtual object SaveViewState ()
 
virtual void TrackViewState ()
 
void SetDirty ()
 
virtual void DataBind ()
 

Static Public Member Functions

static implicit operator ActionItem (ActionItem.Config config)
 

Properties

virtual Icon Icon [get, set]
 An icon to apply to the icon image. To determine the class dynamically, configure the item with a getClass function. More...
 
virtual string IconProxy [get]
 
virtual string IconCls [get, set]
 A CSS class to apply to the icon image. To determine the class dynamically, configure the item with a getClass function. More...
 
virtual string IconUrl [get, set]
 The url of an image to display as the clickable element in the column. More...
 
virtual string? IconUrlProxy [get]
 
virtual JFunction GetClass [get]
 A function which returns the CSS class to apply to the icon image. The function is passed the following parameters: Parameters value : Object The value of the column's configured field (if any). More...
 
virtual JFunction GetTip [get]
 A function which returns the tooltip string for any row. More...
 
virtual JFunction IsDisabled [get]
 A function which determines whether the action item for any row is disabled and returns true or false. More...
 
virtual string Handler [get, set]
 A function called when the icon is clicked. Parameters view : Ext.view.Table The owning TableView. rowIndex : Number The row index clicked on. colIndex : Number The column index clicked on. item : Object The clicked item (or this Column if multiple items were not configured). e : Event The click event. record : Ext.data.Model The Record underlying the clicked row. row : HTMLElement The table row clicked upon. More...
 
virtual string Scope [get, set]
 The scope (this reference) in which the handler, getClass, isDisabled and getTip fuctions are executed. Defaults to this Column. More...
 
virtual string Tooltip [get, set]
 A tooltip message to be displayed on hover. Ext.tip.QuickTipManager must have been initialized. More...
 
virtual bool Disabled [get, set]
 If true, the action will not respond to click events, and will be displayed semi-opaque. More...
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.BaseItem
virtual string InstanceOf [get]
 
ItemState State [get]
 
virtual DefaultValueMode DefaultValueMode [get, set]
 
virtual bool DesignMode [get]
 
bool AutoDataBind [get, set]
 
ResourceManager ResourceManager [get]
 
virtual Control Owner [get, set]
 The Owner Control for this Listener. More...
 
virtual bool IsDefault [get]
 Does this object currently represent it's default state. More...
 
bool IsTrackingViewState [get]
 
EventHandlerList Events [get]
 
EventHandler DataBinding
 
Control?? BindingContainer [get]
 
virtual ConfigItemCollection?? CustomConfig [get]
 Collection of custom js config More...
 
virtual ConfigOptionsCollection ConfigOptions [get]
 
virtual ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
System.Web.Mvc.HtmlHelper?? HtmlHelper [get, set]
 
- Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection ConfigOptions [get]
 
ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
DefaultValueMode DefaultValueMode [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Ext.Net.BaseItem
 BaseItem (Control owner)
 
 BaseItem ()
 
virtual void OwnerUpdate (Control owner)
 
virtual void OnDataBinding (EventArgs e)
 

Detailed Description

Action column item definition

Constructor & Destructor Documentation

◆ ActionItem() [1/2]

Ext.Net.ActionItem.ActionItem ( )
inline

◆ ActionItem() [2/2]

Ext.Net.ActionItem.ActionItem ( Config  config)
inline

Member Function Documentation

◆ operator ActionItem()

static implicit Ext.Net.ActionItem.operator ActionItem ( ActionItem.Config  config)
inlinestatic

◆ ToBuilder()

ActionItem.Builder Ext.Net.ActionItem.ToBuilder ( )
inline

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.ActionItem.ToNativeBuilder ( )
inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.ActionItem.ConfigOptions
get

◆ Disabled

virtual bool Ext.Net.ActionItem.Disabled
getset

If true, the action will not respond to click events, and will be displayed semi-opaque.

◆ GetClass

virtual JFunction Ext.Net.ActionItem.GetClass
get

A function which returns the CSS class to apply to the icon image. The function is passed the following parameters: Parameters value : Object The value of the column's configured field (if any).

metadata : Object An object in which you may set the following attributes:

tdCls : String
        A CSS class name to add to the cell's TD element.
tdAttr : String
        An HTML attribute definition string to apply to the data container element within the table cell (e.g. 'style="color:red;"').
style : String

record : Ext.data.Record The Record providing the data.

rowIndex : Number The row index.

colIndex : Number The column index.

store : Ext.data.Store The Store which is providing the data Model.

view : Ext.grid.View

◆ GetTip

virtual JFunction Ext.Net.ActionItem.GetTip
get

A function which returns the tooltip string for any row.

Parameters value : Object The value of the column's configured field (if any). metadata : Object An object in which you may set the following attributes: css : String A CSS class name to add to the cell's TD element. attr : String An HTML attribute definition string to apply to the data container element within the table cell (e.g. 'style="color:red;"'). record : Ext.data.Model The Record providing the data. rowIndex : Number The row index. colIndex : Number The column index. store : Ext.data.Store The Store which is providing the data Model. view : Ext.grid.View

◆ Handler

virtual string Ext.Net.ActionItem.Handler
getset

A function called when the icon is clicked. Parameters view : Ext.view.Table The owning TableView. rowIndex : Number The row index clicked on. colIndex : Number The column index clicked on. item : Object The clicked item (or this Column if multiple items were not configured). e : Event The click event. record : Ext.data.Model The Record underlying the clicked row. row : HTMLElement The table row clicked upon.

◆ Icon

virtual Icon Ext.Net.ActionItem.Icon
getset

An icon to apply to the icon image. To determine the class dynamically, configure the item with a getClass function.

◆ IconCls

virtual string Ext.Net.ActionItem.IconCls
getset

A CSS class to apply to the icon image. To determine the class dynamically, configure the item with a getClass function.

◆ IconProxy

virtual string Ext.Net.ActionItem.IconProxy
getprotected

◆ IconUrl

virtual string Ext.Net.ActionItem.IconUrl
getset

The url of an image to display as the clickable element in the column.

◆ IconUrlProxy

virtual string? Ext.Net.ActionItem.IconUrlProxy
getprotected

◆ IsDisabled

virtual JFunction Ext.Net.ActionItem.IsDisabled
get

A function which determines whether the action item for any row is disabled and returns true or false.

Parameters view : Ext.view.Table The owning TableView. rowIndex : Number The row index. colIndex : Number The column index. item : Object The clicked item (or this Column if multiple items were not configured). record : Ext.data.Model The Record underlying the row.

◆ Scope

virtual string Ext.Net.ActionItem.Scope
getset

The scope (this reference) in which the handler, getClass, isDisabled and getTip fuctions are executed. Defaults to this Column.

◆ Tooltip

virtual string Ext.Net.ActionItem.Tooltip
getset

A tooltip message to be displayed on hover. Ext.tip.QuickTipManager must have been initialized.


The documentation for this class was generated from the following files: