Class TIWBSCustomControl
Unit
IWBSCustomControl
Declaration
type TIWBSCustomControl = class(TIWCustomControl, IIWBSComponent)
Description
Base class for IWBS controls
Hierarchy
- TIWCustomControl
- TIWBSCustomControl
Overview
Methods
Properties
Description
Methods
 |
constructor Create(AOwner: TComponent); override; |
|
|
|
destructor Destroy; override; |
|
|
|
function IsStoredCustomAsyncEvents: Boolean; |
|
|
|
function IsStoredCustomRestEvents: Boolean; |
|
|
|
function JQSelector: string; |
|
returns a string representing the the JQSelector for this object.
IWBSCustomControl.JQSelector > '$(#"htmlname")'
|
|
procedure AsyncRefreshControl; |
|
Force a full refresh of the control during an Async call.
Usually there is no need to use this method, only if some property changed during async calls is not reflected.
|
|
procedure AsyncRemoveControl; |
|
Remove a control from html flow. You should execute this when destroying a control durinc async calls before Freeing
If you are destroying a region is enought to execute this in that region, you don't need to execute it in each child control.
|
Properties
 |
property CustomAsyncEvents: TIWBSCustomAsyncEvents read GetCustomAsyncEvents write SetCustomAsyncEvents stored IsStoredCustomAsyncEvents; |
|
Mainteins a list of TIWBSCustomAsyncEvent.
CustomAsyncEvent let you bind delphi code execution to practically any jQuery event of the control.
This is usefull when you apply third party plugins to the control.
|
|
property Enabled; |
|
Specifies whether the control responds to mouse, keyboard, and timer events.
|
|
property ExtraTagParams; |
|
|
|
property FriendlyName; |
|
|
|
property OnAsyncChange; |
|
|
|
property OnAsyncClick; |
|
|
|
property OnAsyncDoubleClick; |
|
|
|
property OnAsyncEnter; |
|
|
|
property OnAsyncExit; |
|
|
|
property OnAsyncKeyDown; |
|
|
|
property OnAsyncKeyPress; |
|
|
|
property OnAsyncKeyUp; |
|
|
|
property OnAsyncMouseDown; |
|
|
|
property OnAsyncMouseMove; |
|
|
|
property OnAsyncMouseOut; |
|
|
|
property OnAsyncMouseOver; |
|
|
|
property OnAsyncMouseUp; |
|
|
|
property OnHTMLtag; |
|
Occurs after HTMLTag is created
|
|
property OnRenderAsync: TNotifyEvent read FOnRenderAsync write FOnRenderAsync; |
|
Occurs after component is updated during async calls
|
|
property Script: TStringList read GetScript write SetScript; |
|
Specifies user javascript code that will be rendered and executed with this object.
You can define ScriptParams inside the script. ScriptParams are specified in scripts as: {%param%}.
With property ScriptInsideTag you can define if the script will be rendered inside or outside the script.
|
|
property ScriptEvents; |
|
Maintains a list of JS events you can directly write events in JS
at design time you can access to a limited set of events, but at runtime you can attach to any event of the control doing:
(IWBSCustomControl.ScriptEvents.Values['object.custom.event'] := 'your javascript code...'; or if you want to define the function params:
(IWBSCustomControl.ScriptEvents.Values['object.custom.event'] := 'function (param1, param2, param3) { your javascript code... }';
|
|
property ScriptInsideTag: boolean read GetScriptInsideTag write SetScriptInsideTag default True; |
|
Specifies if the script will be rendered inside the control tag or not.
If true (default) the script will be rendered inside the tag.
If false a new div will be created to surround the control and the script will be rendered in this div, outside the control tag.
this sometimes is necessary when plugins will change the content of the control tag.
|
|
property ScriptParams: TIWBSScriptParams read GetScriptParams write SetScriptParams; |
|
Params that will be replaced in scripts and in some controls content, for example in TIWBSText.
Params are specified in scripts as: {%param%}.
|
|
property Style: TStringList read GetStyle write SetStyle; |
|
List of inline styles in pairs name: value
|
|
property TabIndex: integer read FTabIndex write FTabIndex default 0; |
|
Corresponds to html tabindex attribute. It will be rendered if tabindex <> 0. Set to -1 to disable tabstop
|
Generated by PasDoc 0.14.0.
|