controls.js

Summary
controls.js
Variables
ngControlsVerMain version of the Controls framework.
ngControlsSubVerSubversion of the Controls framework.
ngControlsAPIVersionVersion of the Controls framework evaluated as string.
ngControlsAPICopyrightControls framework copyright information.
ngAppReference to running ngApplication object.
ngc_LangApplication languages resource strings/objects.
ngIE6AlignFixIf TRUE, the controls API fixes right align property in IE6.
Functions
ngLangDefines resource string/object.
ngBeginLangBegins block of locale definition with id lngid.
ngBeginLangEnd block of locale definition.
ngTxtGets locale text.
ngResGets locale resource object.
ngGetControlByIdGets control object by ID.
ngGetControlByElementGets control object by DOM element.
ng_MergeDefMerges two control definitions.
ngCreateControlCreates control by definition.
ngCreateControlAsTypeCreates control by definition and type.
ngControlThis is an abstract class for all visual controls.
Definition
Type...
L...
T...
W...
H...
R...
B...
ScrollBars...
Data...
style...
Opacity...
className...
innerHTML...
id...
parent...
Controls...
ParentReferences...
IE6AlignFix...
OnCreated
OnCreateHTMLElement
Properties
IDControl identificator.
CtrlTypeControl type.
CtrlInheritedFromControl inheritance info.
BaseClassNameControl CSS base class.
EnabledControls whether the control responds to mouse, keyboard.
VisibleDetermines whether the control is visible.
BoundsSpecifies the position of the control.
OwnerIf present, contains reference to object which holds reference to the control.
ParentControlIf present, contains reference to the parent of the control.
ChildControlsIf present, contains references to child controls.
GesturesIf present, the properties of object represents gestures and values specifies if gesture is enabled or not (true/false).
Methods
EnableEnables control.
DisableDisables control.
SetEnabledSets enabled state of the control.
SetVisibleSets control visibility.
SetFocusSets focus on the control.
ElmGets access to container DIV element object.
CtrlInheritsFromChecks if control is inherited from given type.
CreateCreates control DIV container.
DisposeDestroys the control.
SetBoundsUpdates or sets position of the control.
SetScrollBarsSets scroll bars apperance.
SetPopupSets if control work as popup.
SetOpacitySets control opacity.
AlignAligns control to its position.
AttachAttaches control to DIV container.
ReleaseClears control’s DIV container.
UpdateRedraws control.
Events
AddEventAdds new function to the event handler (callback).
RemoveEventRemoves function from the event handler (callback).
OnSetEnabled
OnEnabledChanged
OnSetVisible
OnVisibleChanged
OnUpdate
OnUpdated
OnMouseEnter
OnMouseLeave
ngSysControlThis is an abstract class for all non-visual controls.
Properties
IDControl identificator.
CtrlTypeControl type.
CtrlInheritedFromControl inheritance info.
EnabledControls whether the control responds to mouse, keyboard.
OwnerIf present, contains reference to object which holds reference to the control.
ParentControlIf present, contains reference to the parent of the control.
ChildControlsIf present, contains references to child controls.
Methods
CtrlInheritsFromChecks if control is inherited from given type.
EnableEnables control.
DisableDisables control.
SetEnabledSets enabled state of the control.
ElmGets access to container DIV element object.
CreateCreates control.
DisposeDestroys the control.
Events
AddEventAdds new function to the event handler (callback).
RemoveEventRemoves function from the event handler (callback).
OnSetEnabled
OnEnabledChanged
ngApplicationThis class encapsulates web application.
Properties
AppPath...
Lang...
ElmID...
StartParams...
LocationHash...
MobileKeyboardFix...
Methods
GetLangGets existing application language.
TextGets resource string by application language.
ResourceGets resource by application language.
RunExecutes the application.
SetTitleSets application title.
MessageBoxDisplays a message to user.
AlertDisplays a message to user.
ConfirmDisplays a message with Yes or No buttons to user.
ParamGets application input parameter (from URL).
SetParamSets application parameter value (and optionaly its type).
SetClientParamSets application client parameter value.
SetURLParamSets application URL parameter value.
SetServerParamSets application server parameter value.
ParamTypeGets application parameter type.
SetParamTypeSets application parameter type.
SetParamEncodingFncSets application parameter encoding and decoding functions.
PersistParamSets application parameter persistence.
ParseParamsParse application parameters from browser’s or given URL.
UpdateParamsUpdate application client parameters.
BeginUpdateParamsPrevents the updating of application client parameters until the EndUpdateParams method is called.
EndUpdateParamsPerforms application client parameters update deferred by a call to BeginUpdateParams.
InvokeLaterInvokes event after all remaining JavaScript code is executed and flow is returned back to browser.
CallCall application on another URL.
CallServerCall server on specified URL.
CallServerExCall server on specified URL with parameters.
ElmGets access to application container DIV element object.
RegisterAPIRegisters new application API.
UnregisterAPIUnregisters existing application API.
GetAPIGets application API by selected id.
GetAPIAllGets all application API by selected id.
GetAPIByStrVersionGets exact application API by its string version.
GetAPIAllByStrVersionGets all APIs which matches exact string version.
Events
OnRun
OnRunFinished
OnParamsChanged
OnSetParam
OnGetParam
OnDecodeParam
OnEncodeParam
OnCallURL
OnCall
OnCallServerURL
OnServerCall
OnMapParamsChanged
OnDeviceChanged
ngControlsThis class represents references to a group of controls.
Methods
UpdateRedraws all controls.
ReleaseClears all control’s DIV containers.
DisposeDestroys all controls.
AddControlsAdds controls.
ngPanelThis class implements a generic panel control.
ngFrameStandard frame control (based on ngPanel).
Definition
ParentReferences...
ngTextThis class implements a generic static text control.
Properties
TextAlign...
AutoSize...
AutoSizeMode...
MinWidth...
MinHeight...
Text...
Alt...
HTMLEncode...
CanSelect...
Methods
SetTextSets new text content.
GetTextGets text content.
GetAltGets alt text.
Events
OnSetText
OnGetText
OnGetAlt
ngImageThis class implements a generic image control.
Properties
Alt...
Img...
AutoSize...
Methods
GetAltGets alt text.
GetImgGets image.
Events
OnGetAlt
OnGetImg
ngImageMapThis class implements a generic imagemap control.
Properties
Alt...
Img...
Cursor...
AutoSize...
Shapes...
Methods
GetAltGets alt text.
GetImgGets image.
Events
OnGetAlt
OnGetImg
OnGetShapeAlt
OnShapeClick
OnMouseEnter
OnMouseLeave
OnMouseShapeEnter
OnMouseShapeLeave
ngSysActionThis class implements action non-visual control.
Properties
Text...
Alt...
Checked...
RadioGroup...
Img...
VisibleDetermines whether the control is visible.
Methods
CheckSets new button check state.
ClickClicks the button.
SetTextSets new button text.
Events
OnSetText
OnGetText
OnGetAlt
OnCheckChanged
OnClick
OnGetImg
OnSetVisible
OnVisibleChanged
OnUpdate
ngButtonThis class implements a generic button control.
Properties
Action...
Text...
TextAlign...
Alt...
HTMLEncode...
AutoSize...
MinWidth...
Checked...
RadioGroup...
Cursor...
ReadOnly...
Img...
ImgAlign...
ImgIndent...
LeftImg...
MiddleImg...
RightImg...
Methods
CheckSets new button check state.
ClickClicks the button.
SetTextSets new button text.
GetTextGets text content.
GetAltGets alt text.
Events
OnSetText
OnGetText
OnGetAlt
OnCheckChanged
OnDblClick
OnClick
OnMouseEnter
OnMouseLeave
OnGetImg
OnGetClassName
ngCheckBoxStandard check box control (based on ngButton).
Properties
AllowGrayed...
ngRadioButtonStandard radio button control (based on ngButton).
Properties
AllowGrayed...
ngGroupThis class implements a generic group control.
Definition
CWClientRect width.
CHClientRect height.
ControlsPanelControls panel definition.
Properties
Text...
HTMLEncode...
Frame...
ControlsInside...
Methods
GetTextGets text content.
GetClientRectGets client rectangle dimensions.
SetClientRectSets client rectangle dimensions.
Events
OnGetText
ngEditThis class implements a generic edit control.
Definition
DropDown...
Properties
Text...
DefaultText...
TextAlign...
Alt...
Hint...
HintStyle...
ReadOnly...
Password...
MaxLength...
LeftImg...
MiddleImg...
RightImg...
OffsetTop...
HasFocus...
SelectOnFocus...
Buttons...
DropDownType...
DropDownControl...
DropDownWidth...
DropDownAlign...
Suggestion...
SuggestionDelay...
SuggestionSearchColumn...
SuggestionIgnoreCase...
SuggestionPartial...
SuggestionURL...
SuggestionType...
Methods
SetTextSets edit text.
GetTextGets edit text.
GetAltGets alt text.
GetHintGets hint text.
SetReadOnlySets readonly state of control.
GetCaretPosGets caret position.
SetCaretPosSets caret position.
SetDropDownControlAssigns drop down control to edit box.
DropDownShows drop down.
HideDropDownHides drop down.
SuggestionRefreshRefreshes suggestion content.
Events
OnSetText
OnGetText
OnTextChanged
OnGetAlt
OnGetHint
OnGetClassName
OnDropDown
OnHideDropDown
OnClickOutside
OnKeyDown
OnKeyUp
OnKeyPress
OnMouseEnter
OnMouseLeave
OnFocus
OnBlur
OnGetImg
OnSuggestionSetText
OnSuggestionSearch
OnSuggestionCompareItem
OnSuggestionURL
OnSuggestionResults
OnSuggestionData
ngDropDownStandard drop down control (based on ngEdit).
ngDropDownListStandard drop down list control (based on ngEdit).
ngEditNumStandard edit number control with spin buttons (based on ngEdit).
Definition
ArrowsAlign
Arrows
Properties
Step...
StepRound...
MinNum...
MaxNum...
DefaultNum...
Methods
DoUpIncrease value by Step.
DoDownDecrease value by Step.
GetNumGets number.
SetNumSets number.
ButtonUp...
ButtonDown...
Events
OnGetNum
OnSetNum
OnUp
OnDown
ngMemoThis class implements a generic memo control.
Properties
Text...
DefaultText...
TextAlign...
Alt...
Hint...
HintStyle...
ReadOnly...
Frame...
HasFocus...
SelectOnFocus...
Methods
SetTextSets memo text.
GetTextGets memo text.
GetAltGets alt text.
GetHintGets hint text.
SetReadOnlySets readonly state of control.
GetCaretPosGets caret position.
SetCaretPosSets caret position.
Events
OnSetText
OnGetText
OnTextChanged
OnGetAlt
OnGetHint
OnGetClassName
OnKeyDown
OnKeyUp
OnKeyPress
OnMouseEnter
OnMouseLeave
OnFocus
OnBlur
ngPagesThis class implements a generic page control.
Definition
Pages...
ControlsPanelControls panel definition.
Properties
Page...
PagesVisible...
PagesIndent...
PagesSize...
MaxRows...
PagesAlign...
PagesVAlign...
TextAlign...
HTMLEncode...
Pages...
RowOverlap...
PageImages...
Frame...
Methods
SetPageSets current page index.
GetPageByIdGets page index by page id.
GetIdByPageGets page id by page index.
GetPageObjByIdGets page object by page id.
GetPageByTextGets page index by page text caption.
GetPageByControlGets page index by control placed on page.
GetPageObjByControlGets page object by control placed on page.
SetPageByControlSets page by control placed on page.
Events
OnPageChanging
OnPageChanged
OnGetText
OnGetAlt
OnClick
OnDblClick
ngToolBarThis class implements a generic toolbar control.
Properties
AutoSize...
Vertical...
VPadding...
HPadding...
VAlign...
HAlign...
Wrapable...
Methods
CtrlBringToFrontvoid CtrlBringToFront (object ctrl)
CtrlSendToBackvoid CtrlSendToBack (object ctrl)
CtrlInsertAftervoid CtrlInsertAfter (object ctrl, object whichctrl)
CtrlInsertBeforevoid CtrlInsertBefore (object ctrl, object whichctrl)
Child Controls Properties
ToolBarIgnore...
ToolBarAutoUpdate...
ToolBarIndent...
ToolBarHPadding...
ToolBarVPadding...
ToolBarWidth...
ToolBarHeight...
ToolBarBreak...
ToolBarNoWrap...
ngProgressBarThis class implements a generic progress bar control.
Properties
Position...
Smooth...
LeftImg...
MiddleImg...
RightImg...
BarImg...
Methods
SetPositionSets position of progress in interval 0-100.
BeginProcessStarts waiting animation.
EndProcessEnds waiting animation.
ngWebBrowserThis class implements a web browser control.
Properties
URL...
Methods
SetURLSets browser URL.
GetURLGets browser URL.
SetHTMLSets HTML code directly into browser.
GetBrowserGets browser IFRAME element.
GetDocumentGets browser document object.
Events
OnSetURL
OnGetURL
OnSetHTML

Variables

ngControlsVer

var ngControlsVer

Main version of the Controls framework.

ngControlsSubVer

var ngControlsSubVer

Subversion of the Controls framework.

ngControlsAPIVersion

Version of the Controls framework evaluated as string.

ngControlsAPICopyright

Controls framework copyright information.

ngApp

var ngApp

Reference to running ngApplication object.

ngc_Lang

Application languages resource strings/objects.

ngIE6AlignFix

var ngIE6AlignFix

If TRUE, the controls API fixes right align property in IE6.  Turn off if you don’t care about pixels precision and prefer slightly faster rendering.

Default value: true

Functions

ngLang

function ngLang(id,
data,
lng)

Defines resource string/object.

Syntax: ngLang (string id, mixed data [,string lng])

Returns

-

ngBeginLang

function ngBeginLang(lng)

Begins block of locale definition with id lngid.

Syntax: ngLang (string lngid)

Returns

-

ngBeginLang

End block of locale definition.

Syntax: ngLang (string lngid)

Returns

Actual locale id.

ngTxt

function ngTxt(t,
defval)

Gets locale text.

Syntax: string ngTxt (string id [, mixed defaultvalue])

Returns

Locale text.

ngRes

function ngRes(rid)

Gets locale resource object.

Syntax: object ngRes (string id)

Returns

Locale resource object.

ngGetControlById

function ngGetControlById(id,
type)

Gets control object by ID.

Syntax

object ngGetControlById (string id [, string ctrltype])

Parameters

idcontrol ID
ctrltypecontrol type

Returns

Reference to control object.

ngGetControlByElement

function ngGetControlByElement(elm,
type)

Gets control object by DOM element.

Syntax

object ngGetControlByElement (mixed elm [, string ctrltype])

Parameters

elmDOM element or element id
ctrltypecontrol type

Returns

Reference to element’s parent control object.

ng_MergeDef

function ng_MergeDef(dst,
def,
allowundefined,
callback)

Merges two control definitions.

Syntax

void ng_MergeDef (mixed dst, mixed def [, bool allowundefined=false, function callback])

Parameters

dstdestination definition
defdefinition to be merged
allowundefinedif FALSE (default), undefined values in parameter var are ignored
callbackoptional callback function

Returns

-

ngCreateControl

function ngCreateControl(d,
ref,
parent)

Creates control by definition.

Syntax

object ngCreateControl (object def, object ref, mixed parent)

Parameters

defcontrol definition
refreference owner (object where reference to control is stored)
parentstring ID or object of parent DIV element

Returns

Reference to new control object.

ngCreateControlAsType

function ngCreateControlAsType(def,
type,
ref,
parent)

Creates control by definition and type.  Control type is passed as parameter and type in definition is ignored.

Syntax

object ngCreateControlAsType (object def, string ctrltype, object ref, mixed parent)

Parameters

defcontrol definition
ctrltypecontrol type
refreference owner (object where reference to control is stored)
parentstring ID or object of parent DIV element

Returns

Reference to new control object.

ngControl

This is an abstract class for all visual controls.

Syntax

new ngControl (object obj, string id, string ctrltype)

Parameters

objimplementation of control object
idcontrol ID
ctrltypecontrol type
Summary
Definition
Type...
L...
T...
W...
H...
R...
B...
ScrollBars...
Data...
style...
Opacity...
className...
innerHTML...
id...
parent...
Controls...
ParentReferences...
IE6AlignFix...
OnCreated
OnCreateHTMLElement
Properties
IDControl identificator.
CtrlTypeControl type.
CtrlInheritedFromControl inheritance info.
BaseClassNameControl CSS base class.
EnabledControls whether the control responds to mouse, keyboard.
VisibleDetermines whether the control is visible.
BoundsSpecifies the position of the control.
OwnerIf present, contains reference to object which holds reference to the control.
ParentControlIf present, contains reference to the parent of the control.
ChildControlsIf present, contains references to child controls.
GesturesIf present, the properties of object represents gestures and values specifies if gesture is enabled or not (true/false).
Methods
EnableEnables control.
DisableDisables control.
SetEnabledSets enabled state of the control.
SetVisibleSets control visibility.
SetFocusSets focus on the control.
ElmGets access to container DIV element object.
CtrlInheritsFromChecks if control is inherited from given type.
CreateCreates control DIV container.
DisposeDestroys the control.
SetBoundsUpdates or sets position of the control.
SetScrollBarsSets scroll bars apperance.
SetPopupSets if control work as popup.
SetOpacitySets control opacity.
AlignAligns control to its position.
AttachAttaches control to DIV container.
ReleaseClears control’s DIV container.
UpdateRedraws control.
Events
AddEventAdds new function to the event handler (callback).
RemoveEventRemoves function from the event handler (callback).
OnSetEnabled
OnEnabledChanged
OnSetVisible
OnVisibleChanged
OnUpdate
OnUpdated
OnMouseEnter
OnMouseLeave

Definition

Type

...  Type: string

L

...  Type: integer/string

T

...  Type: integer/string

W

...  Type: integer/string

H

...  Type: integer/string

R

...  Type: integer/string

B

...  Type: integer/string

ScrollBars

...  Type: integer Default value: ssNone

Data

...  Type: object

style

...  Type: object

Opacity

...  Type: double

className

...  Type: string

innerHTML

...  Type: string

id

...  Type: string

parent

...  Type: string/object

Controls

...  Type: object

ParentReferences

...  Type: bool Default value: true

IE6AlignFix

...  Type: bool Default value: global variable IE6AlignFix

OnCreated

OnCreateHTMLElement

Properties

ID

obj.ID

Control identificator.  Type: string

CtrlType

obj.CtrlType

Control type.  Type: string

CtrlInheritedFrom

obj.CtrlInheritedFrom

Control inheritance info.  Type: array

BaseClassName

obj.BaseClassName

Control CSS base class.  Type: string

Enabled

obj.Enabled

Controls whether the control responds to mouse, keyboard.  Type: bool

Visible

obj.Visible

Determines whether the control is visible.  Type: bool

Bounds

obj.Bounds

Specifies the position of the control.  Type: object

Owner

If present, contains reference to object which holds reference to the control.  Type: object

ParentControl

If present, contains reference to the parent of the control.  Type: object

ChildControls

If present, contains references to child controls.  Type: array

Gestures

If present, the properties of object represents gestures and values specifies if gesture is enabled or not (true/false).  Type: object

Methods

Enable

Enables control.

Syntax

void Enable ()

Parameters

Returns

-

Disable

Disables control.

Syntax

void Disable ()

Parameters

Returns

-

SetEnabled

Sets enabled state of the control.

Syntax

void SetEnabled (bool enabled [, object parent])

Parameters

Returns

-

SetVisible

Sets control visibility.

Syntax

void SetVisible (bool visible)

Parameters

Returns

-

SetFocus

Sets focus on the control.

Syntax

void SetFocus ([bool state=true])

Parameters

statecontrol is focused if TRUE or blured if FALSE

Returns

-

Elm

Gets access to container DIV element object.

Syntax

object Elm ()

Returns

Element object.

CtrlInheritsFrom

Checks if control is inherited from given type.

Syntax

bool CtrlInheritsFrom (string type)

Returns

TRUE if control is an ancestor of given type.

Create

Creates control DIV container.

Syntax

void Create (props, ref)

Returns

-

Dispose

Destroys the control.

Syntax

void Dispose ()

Parameters

Returns

-

SetBounds

Updates or sets position of the control.

Syntax

void SetBounds ([object props])

Parameters

Returns

-

SetScrollBars

Sets scroll bars apperance.

Syntax

void SetScrollBars (integer type)

Parameters

typessNone, ssAuto, ssBoth, ssVertical, ssHorizontal

Returns

-

SetPopup

Sets if control work as popup.

Syntax

void SetPopup (bool state)

Parameters

stateif TRUE, control work as popup

Returns

-

SetOpacity

Sets control opacity.

Syntax

void SetOpacity (double opacity)

Parameters

opacitycontrol opacity from interval <0,1>

Returns

-

Align

Aligns control to its position.

Syntax

int Align (object elm)

Parameters

Returns

Align flags.

Attach

Attaches control to DIV container.

Syntax

void Attach ([mixed id])

Parameters

Returns

-

Release

Clears control’s DIV container.

Syntax

void Release ()

Parameters

Returns

-

Update

Redraws control.

Syntax

void Update (bool recursive)

Parameters

Returns

-

Events

AddEvent

Adds new function to the event handler (callback).

Syntax

void AddEvent (string event, function handler)

void AddEvent (function handler, string event)

Parameters

Returns

-

RemoveEvent

Removes function from the event handler (callback).

Syntax

void RemoveEvent (string event, function handler)

Parameters

Returns

-

OnSetEnabled

OnEnabledChanged

OnSetVisible

OnVisibleChanged

OnUpdate

OnUpdated

OnMouseEnter

OnMouseLeave

ngSysControl

This is an abstract class for all non-visual controls.

Syntax

new ngSysControl (object obj, string id, string ctrltype)

Parameters

objimplementation of control object
idcontrol ID
ctrltypecontrol type
Summary
Properties
IDControl identificator.
CtrlTypeControl type.
CtrlInheritedFromControl inheritance info.
EnabledControls whether the control responds to mouse, keyboard.
OwnerIf present, contains reference to object which holds reference to the control.
ParentControlIf present, contains reference to the parent of the control.
ChildControlsIf present, contains references to child controls.
Methods
CtrlInheritsFromChecks if control is inherited from given type.
EnableEnables control.
DisableDisables control.
SetEnabledSets enabled state of the control.
ElmGets access to container DIV element object.
CreateCreates control.
DisposeDestroys the control.
Events
AddEventAdds new function to the event handler (callback).
RemoveEventRemoves function from the event handler (callback).
OnSetEnabled
OnEnabledChanged

Properties

ID

obj.ID

Control identificator.  Type: string

CtrlType

obj.CtrlType

Control type.  Type: string

CtrlInheritedFrom

obj.CtrlInheritedFrom

Control inheritance info.  Type: array

Enabled

obj.Enabled

Controls whether the control responds to mouse, keyboard.  Type: bool

Owner

If present, contains reference to object which holds reference to the control.  Type: object

ParentControl

If present, contains reference to the parent of the control.  Type: object

ChildControls

If present, contains references to child controls.  Type: array

Methods

CtrlInheritsFrom

Checks if control is inherited from given type.

Syntax

bool CtrlInheritsFrom (string type)

Returns

TRUE if control is an ancestor of given type.

Enable

Enables control.

Syntax

void Enable ()

Parameters

Returns

-

Disable

Disables control.

Syntax

void Disable ()

Parameters

Returns

-

SetEnabled

Sets enabled state of the control.

Syntax

void SetEnabled (bool enabled [, object parent])

Parameters

Returns

-

Elm

obj.Elm = function()

Gets access to container DIV element object.

Syntax

object Elm ()

Returns

Element object.

Create

Creates control.

Syntax

void Create (props, ref)

Returns

-

Dispose

Destroys the control.

Syntax

void Dispose ()

Parameters

Returns

-

Events

AddEvent

Adds new function to the event handler (callback).

Syntax

void AddEvent (string event, function handler)

void AddEvent (function handler, string event)

Parameters

Returns

-

RemoveEvent

Removes function from the event handler (callback).

Syntax

void RemoveEvent (string event, function handler)

Parameters

Returns

-

OnSetEnabled

OnEnabledChanged

ngApplication

This class encapsulates web application.

Syntax

new ngApplication ([object startparams = { }, string elm = ‘ngApp’, bool autorun=true])

Parameters

startparamsapplication startup parameters
elmapplication container DIV id
autorunrun application after object creation
Summary
Properties
AppPath...
Lang...
ElmID...
StartParams...
LocationHash...
MobileKeyboardFix...
Methods
GetLangGets existing application language.
TextGets resource string by application language.
ResourceGets resource by application language.
RunExecutes the application.
SetTitleSets application title.
MessageBoxDisplays a message to user.
AlertDisplays a message to user.
ConfirmDisplays a message with Yes or No buttons to user.
ParamGets application input parameter (from URL).
SetParamSets application parameter value (and optionaly its type).
SetClientParamSets application client parameter value.
SetURLParamSets application URL parameter value.
SetServerParamSets application server parameter value.
ParamTypeGets application parameter type.
SetParamTypeSets application parameter type.
SetParamEncodingFncSets application parameter encoding and decoding functions.
PersistParamSets application parameter persistence.
ParseParamsParse application parameters from browser’s or given URL.
UpdateParamsUpdate application client parameters.
BeginUpdateParamsPrevents the updating of application client parameters until the EndUpdateParams method is called.
EndUpdateParamsPerforms application client parameters update deferred by a call to BeginUpdateParams.
InvokeLaterInvokes event after all remaining JavaScript code is executed and flow is returned back to browser.
CallCall application on another URL.
CallServerCall server on specified URL.
CallServerExCall server on specified URL with parameters.
ElmGets access to application container DIV element object.
RegisterAPIRegisters new application API.
UnregisterAPIUnregisters existing application API.
GetAPIGets application API by selected id.
GetAPIAllGets all application API by selected id.
GetAPIByStrVersionGets exact application API by its string version.
GetAPIAllByStrVersionGets all APIs which matches exact string version.
Events
OnRun
OnRunFinished
OnParamsChanged
OnSetParam
OnGetParam
OnDecodeParam
OnEncodeParam
OnCallURL
OnCall
OnCallServerURL
OnServerCall
OnMapParamsChanged
OnDeviceChanged

Properties

AppPath

this.AppPath

...  Type: string

Lang

this.Lang

...  Type: string

ElmID

...  Type: string

StartParams

...  Type: object

LocationHash

this.LocationHash

...  Type: string

MobileKeyboardFix

this.MobileKeyboardFix

...  Type: bool

Methods

GetLang

Gets existing application language.

Syntax

string GetLang ()

Returns

-

Text

Gets resource string by application language.

Syntax

string Text (string restext, string defval)

Returns

-

Resource

Gets resource by application language.

Syntax

object Resource (string resid)

Returns

-

Run

Executes the application.

Syntax

void Run ()

Returns

-

SetTitle

Sets application title.

Syntax

void SetTitle (string restext)

Returns

-

MessageBox

Displays a message to user.

Syntax

bool MessageBox (string restext [, bool yesno=false])

Returns

-

Alert

Displays a message to user.

Syntax

void Alert (string restext)

Returns

-

Confirm

this.Confirm=function(t)

Displays a message with Yes or No buttons to user.

Syntax

bool Confirm (string restext)

Returns

-

Param

Gets application input parameter (from URL).

Syntax

string Param (string paramname)

Returns

-

SetParam

Sets application parameter value (and optionaly its type).

Syntax

void SetParam (mixed param, string value[, int type])

Returns

-

SetClientParam

Sets application client parameter value.

Syntax

void SetClientParam (mixed param, string value)

Returns

-

SetURLParam

Sets application URL parameter value.

Syntax

void SetURLParam (mixed param, string value)

Returns

-

SetServerParam

Sets application server parameter value.

Syntax

void SetServerParam (mixed param, string value)

Returns

-

ParamType

Gets application parameter type.

Syntax

enum ParamType (string paramname)

Constants

APPPARAM_SERVER...
APPPARAM_CLIENT...
APPPARAM_URL...

Returns

-

SetParamType

Sets application parameter type.

Syntax

void SetParamType (mixed param, enum paramtype)

Returns

-

SetParamEncodingFnc

Sets application parameter encoding and decoding functions.

Syntax

void SetParamEncodingFnc (string paramname, function encodefnc, function decodefnc)

Returns

-

PersistParam

Sets application parameter persistence.

Syntax

void PersistParam (mixed param [, bool persistent=true])

Returns

-

ParseParams

Parse application parameters from browser’s or given URL.

Syntax

void ParseParams ([string url])

Returns

-

UpdateParams

Update application client parameters.

Syntax

void UpdateParams ()

Returns

-

BeginUpdateParams

Prevents the updating of application client parameters until the EndUpdateParams method is called.

Syntax

void BeginUpdateParams ()

Returns

-

EndUpdateParams

Performs application client parameters update deferred by a call to BeginUpdateParams.

Syntax

void EndUpdateParams ()

Returns

-

InvokeLater

Invokes event after all remaining JavaScript code is executed and flow is returned back to browser.

Syntax

void InvokeLater (function event)

Parameters

eventevent to be called

Returns

-

Call

Call application on another URL.

Syntax

void Call (string url)

Returns

-

CallServer

Call server on specified URL.

Syntax

void CallServer (string url, bool nocache)

Returns

-

CallServerEx

Call server on specified URL with parameters.

Syntax

void CallServerEx (string url, object parameters, bool nocache)

Returns

-

Elm

Gets access to application container DIV element object.

Syntax

object Elm ()

Returns

Element object.

RegisterAPI

Registers new application API.

Syntax

bool RegisterAPI (string id, object api, string version, mixed owner)

Returns

TRUE if API was successfuly registered.

UnregisterAPI

Unregisters existing application API.

Syntax

bool UnregisterAPI (string id [, mixed owner, string version])

Returns

TRUE if API was successfuly unregistered.

GetAPI

Gets application API by selected id.

Syntax

object GetAPI (string id [, string minreqversion, string maxreqversion])

Returns

API object or null if not found.

GetAPIAll

Gets all application API by selected id.

Syntax

array GetAPIAll (string id [, string minreqversion, string maxreqversion])

Returns

list of APIs

GetAPIByStrVersion

Gets exact application API by its string version.

Syntax

object GetAPIByStrVersion (string id, string strversion)

Returns

API object or null if not found.

GetAPIAllByStrVersion

Gets all APIs which matches exact string version.

Syntax

array GetAPIAllByStrVersion (string id, string strversion)

Returns

list of APIs

Events

OnRun

OnRunFinished

OnParamsChanged

OnSetParam

OnGetParam

OnDecodeParam

OnEncodeParam

OnCallURL

OnCall

OnCallServerURL

OnServerCall

OnMapParamsChanged

OnDeviceChanged

ngControls

This class represents references to a group of controls.

Syntax

new ngControls (object defs [, mixed parent])

Parameters

defscontrols definition
parentparent DIV container
Summary
Methods
UpdateRedraws all controls.
ReleaseClears all control’s DIV containers.
DisposeDestroys all controls.
AddControlsAdds controls.

Methods

Update

this.Update = function()

Redraws all controls.

Syntax

void Update ()

Parameters

Returns

-

Release

this.Release = function()

Clears all control’s DIV containers.

Syntax

void Release ()

Parameters

Returns

-

Dispose

this.Dispose = function()

Destroys all controls.

Syntax

void Dispose ()

Parameters

Returns

-

AddControls

this.AddControls = function(defs,
parent)

Adds controls.

Syntax

void AddControls (defs, parent)

Parameters

Returns

-

ngPanel

This class implements a generic panel control.

Syntax

new ngPanel ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

ngFrame

Standard frame control (based on ngPanel).

Definition

ParentReferences

...  Type: bool Default value: false

ngText

This class implements a generic static text control.

Syntax

new ngText ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary

Properties

TextAlign

this.TextAlign

...  Type: string Default value: ’left’

AutoSize

this.AutoSize

...  Type: bool

AutoSizeMode

this.AutoSizeMode

...  Type: string Default value: ’auto’

MinWidth

...  Type: integer Default value: undefined

MinHeight

...  Type: integer Default value: undefined

Text

this.Text

...  Type: string

Alt

this.Alt

...  Type: string

HTMLEncode

this.HTMLEncode

...  Type: bool Default value: false

CanSelect

this.CanSelect

...  Type: bool Default value: true

Methods

SetText

Sets new text content.

Syntax

void SetText (string text)

Parameters

Returns

-

GetText

Gets text content.

Syntax

string GetText (void)

Returns

Text content.

GetAlt

Gets alt text.

Syntax

string GetAlt (void)

Returns

Alt text.

Events

OnSetText

OnGetText

OnGetAlt

ngImage

This class implements a generic image control.

Syntax

new ngImage ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary

Properties

Alt

this.Alt

...  Type: string

Img

this.Img

...  Type: object

AutoSize

this.AutoSize

...  Type: bool

Methods

GetAlt

Gets alt text.

Syntax

string GetAlt (void)

Returns

Alt text.

GetImg

Gets image.

Syntax

object GetImg (void)

Returns

The image.

Events

OnGetAlt

OnGetImg

ngImageMap

This class implements a generic imagemap control.

Syntax

new ngImageMap ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Properties

Alt

this.Alt

...  Type: string

Img

this.Img

...  Type: object

Cursor

...  Type: string

AutoSize

this.AutoSize

...  Type: bool

Shapes

this.Shapes

...  Type: array

Methods

GetAlt

Gets alt text.

Syntax

string GetAlt (void)

Returns

Alt text.

GetImg

Gets image.

Syntax

object GetImg (void)

Returns

The image.

Events

OnGetAlt

OnGetImg

OnGetShapeAlt

OnShapeClick

OnMouseEnter

OnMouseLeave

OnMouseShapeEnter

OnMouseShapeLeave

ngSysAction

This class implements action non-visual control.

Syntax

new ngSysAction ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary
Properties
Text...
Alt...
Checked...
RadioGroup...
Img...
VisibleDetermines whether the control is visible.
Methods
CheckSets new button check state.
ClickClicks the button.
SetTextSets new button text.
Events
OnSetText
OnGetText
OnGetAlt
OnCheckChanged
OnClick
OnGetImg
OnSetVisible
OnVisibleChanged
OnUpdate

Properties

Text

this.Text

...  Type: string

Alt

this.Alt

...  Type: string

Checked

...  Type: int Default value: 0

RadioGroup

...  Type: string Default value: undefined

Img

...  Type: object

Visible

this.Visible

Determines whether the control is visible.  Type: bool

Methods

Check

Sets new button check state.

Syntax

void Check (int newval)

Parameters

Returns

-

Click

Clicks the button.

Syntax

void Click ([event ev])

Parameters

Returns

-

SetText

Sets new button text.

Syntax

void SetText (string text)

Parameters

Returns

-

Events

OnSetText

OnGetText

OnGetAlt

OnCheckChanged

OnClick

OnGetImg

OnSetVisible

OnVisibleChanged

OnUpdate

ngButton

This class implements a generic button control.

Syntax

new ngButton ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Properties

Action

this.Action

...  Type: mixed

Text

this.Text

...  Type: string

TextAlign

this.TextAlign

...  Type: string Default value: ‘center’

Alt

this.Alt

...  Type: string

HTMLEncode

this.HTMLEncode

...  Type: bool Default value: false

AutoSize

this.AutoSize

...  Type: bool Default value: true

MinWidth

...  Type: integer Default value: undefined

Checked

this.Checked

...  Type: int Default value: 0

RadioGroup

...  Type: string Default value: undefined

Cursor

...  Type: string Default value: ’pointer’

ReadOnly

...  Type: bool Default value: false

Img

this.Img

...  Type: object

ImgAlign

this.ImgAlign

...  Type: string Default value: ’left’

ImgIndent

this.ImgIndent

...  Type: int Default value: 0

LeftImg

this.LeftImg

...  Type: object

MiddleImg

this.MiddleImg

...  Type: object

RightImg

this.RightImg

...  Type: object

Methods

Check

Sets new button check state.

Syntax

void Check (int newval)

Parameters

Returns

-

Click

Clicks the button.

Syntax

void Click ([event ev])

Parameters

Returns

-

SetText

Sets new button text.

Syntax

void SetText (string text)

Parameters

Returns

-

GetText

Gets text content.

Syntax

string GetText (void)

Returns

Text content.

GetAlt

Gets alt text.

Syntax

string GetAlt (void)

Returns

Alt text.

Events

OnSetText

OnGetText

OnGetAlt

OnCheckChanged

OnDblClick

OnClick

OnMouseEnter

OnMouseLeave

OnGetImg

OnGetClassName

ngCheckBox

Standard check box control (based on ngButton).

Properties

AllowGrayed

...  Type: bool Default value: false

ngRadioButton

Standard radio button control (based on ngButton).

Properties

AllowGrayed

...  Type: bool Default value: false

ngGroup

This class implements a generic group control.

Syntax

new ngGroup ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary
Definition
CWClientRect width.
CHClientRect height.
ControlsPanelControls panel definition.
Properties
Text...
HTMLEncode...
Frame...
ControlsInside...
Methods
GetTextGets text content.
GetClientRectGets client rectangle dimensions.
SetClientRectSets client rectangle dimensions.
Events
OnGetText

Definition

CW

ClientRect width.  Type: integer

CH

ClientRect height.  Type: integer

ControlsPanel

Controls panel definition.  Type: object

Properties

Text

this.Text

...  Type: string

HTMLEncode

this.HTMLEncode

...  Type: bool Default value: false

Frame

this.Frame

...  Type: object

ControlsInside

this.ControlsInside

...  Type: bool Default value: true

Methods

GetText

Gets text content.

Syntax

string GetText (void)

Returns

Text content.

GetClientRect

Gets client rectangle dimensions.

Syntax

object GetClientRect ()

Returns

Rectangle dimensions in format { W: width, H: height }.

SetClientRect

Sets client rectangle dimensions.

Syntax

void SetClientRect (object rect)

Parameters

rect{ W: width, H: height } Returns: -

Events

OnGetText

ngEdit

This class implements a generic edit control.

Syntax

new ngEdit ([string id, string text=’’])

Parameters

idparent element
textedit text

See also

Abstract class ngControl.

Definition

DropDown

...  Type: object

Properties

Text

this.Text

...  Type: string

DefaultText

this.DefaultText

...  Type: string

TextAlign

this.TextAlign

...  Type: string Default value: ’left’

Alt

this.Alt

...  Type: string

Hint

this.Hint

...  Type: string

HintStyle

...  Type: integer

ReadOnly

this.ReadOnly

...  Type: bool Default value: false

Password

this.Password

...  Type: bool Default value: false

MaxLength

this.MaxLength

...  Type: int Default value: 0

LeftImg

this.LeftImg

...  Type: object

MiddleImg

this.MiddleImg

...  Type: object

RightImg

this.RightImg

...  Type: object

OffsetTop

this.OffsetTop

...  Type: int Default value: 0

HasFocus

this.HasFocus

...  Type: bool Default value: false

SelectOnFocus

this.SelectOnFocus

...  Type: bool Default value: true

Buttons

this.Buttons

...  Type: array Default value: null

DropDownType

this.DropDownType

...  Type: enum

Constants

ngeDropDownEdit...
ngeDropDownList...

Default value: ngeDropDownEdit

DropDownControl

this.DropDownControl

...  Type: object Default value: null

DropDownWidth

this.DropDownWidth

...  Type: integer Default value: undefined

DropDownAlign

this.DropDownAlign

...  Type: string Default value: ’left’

Suggestion

...  Type: bool Default value: false

SuggestionDelay

...  Type: int Default value: 200

SuggestionSearchColumn

...  Type: string Default value: ’’

SuggestionIgnoreCase

...  Type: bool Default value: true

SuggestionPartial

...  Type: int Default value: 2

SuggestionURL

...  Type: string Default value: ’’

SuggestionType

...  Type: string Default value: ’’

Methods

SetText

Sets edit text.

Syntax

void SetText (string text)

Returns

-

GetText

Gets edit text.

Syntax

string GetText ()

Returns

-

GetAlt

Gets alt text.

Syntax

string GetAlt (void)

Returns

Alt text.

GetHint

Gets hint text.

Syntax

string GetHint (void)

Returns

Hint text.

SetReadOnly

Sets readonly state of control.

Syntax

void SetReadOnly ([bool ro=true])

Parameters

roreadonly state

Returns

-

GetCaretPos

Gets caret position.

Syntax

int GetCaretPos ()

Returns

Caret position or undefined if edit is not focused.

SetCaretPos

Sets caret position.

Syntax

void SetCaretPos (int pos)

Parameters

rocaret position

Returns

-

SetDropDownControl

Assigns drop down control to edit box.

Syntax

void SetDropDownControl (object control)

Returns

-

DropDown

Shows drop down.

Syntax

void DropDown ()

Returns

-

HideDropDown

Hides drop down.

Syntax

void HideDropDown ()

Returns

-

SuggestionRefresh

Refreshes suggestion content.

Syntax

void SuggestionRefresh ([bool forcerequery=false, delay=undefined])

Returns

-

Events

OnSetText

OnGetText

OnTextChanged

OnGetAlt

OnGetHint

OnGetClassName

OnDropDown

OnHideDropDown

OnClickOutside

OnKeyDown

OnKeyUp

OnKeyPress

OnMouseEnter

OnMouseLeave

OnFocus

OnBlur

OnGetImg

OnSuggestionSetText

OnSuggestionSearch

OnSuggestionCompareItem

OnSuggestionURL

OnSuggestionResults

OnSuggestionData

ngDropDown

Standard drop down control (based on ngEdit).

ngDropDownList

Standard drop down list control (based on ngEdit).

ngEditNum

Standard edit number control with spin buttons (based on ngEdit).

Definition

ArrowsAlign

Constants

’left’...
’right’...
’both’...

Arrows

Constants

’none’...
’leftright’...
’updown’...

Properties

Step

...  Type: integer Default value: 1

StepRound

...  Type: bool Default value: false

MinNum

...  Type: integer

MaxNum

...  Type: integer

DefaultNum

...  Type: integer Default value: 0

Methods

DoUp

c.DoUp = function()

Increase value by Step.

Syntax

void DoUp ()

Parameters

Returns

-

DoDown

c.DoDown = function()

Decrease value by Step.

Syntax

void DoDown ()

Parameters

Returns

-

GetNum

c.GetNum = function()

Gets number.

Syntax

int GetNum ()

Parameters

Returns

-

SetNum

c.SetNum = function(n)

Sets number.

Syntax

void SetNum (int n)

Parameters

Returns

-

ButtonUp

c.ButtonUp

...  Type: ngButton

ButtonDown

c.ButtonDown

...  Type: ngButton

Events

OnGetNum

OnSetNum

OnUp

OnDown

ngMemo

This class implements a generic memo control.

Syntax

new ngMemo ([string id, string text=’’])

Parameters

idparent element
textmemo text

See also

Abstract class ngControl.

Properties

Text

this.Text

...  Type: string

DefaultText

this.DefaultText

...  Type: string

TextAlign

this.TextAlign

...  Type: string Default value: ’left’

Alt

this.Alt

...  Type: string

Hint

this.Hint

...  Type: string

HintStyle

...  Type: integer

ReadOnly

this.ReadOnly

...  Type: bool Default value: false

Frame

this.Frame

...  Type: object

HasFocus

this.HasFocus

...  Type: bool Default value: false

SelectOnFocus

this.SelectOnFocus

...  Type: bool Default value: true

Methods

SetText

Sets memo text.

Syntax

void SetText (string text)

Returns

-

GetText

Gets memo text.

Syntax

string GetText ()

Returns

Memo text.

GetAlt

Gets alt text.

Syntax

string GetAlt (void)

Returns

Alt text.

GetHint

Gets hint text.

Syntax

string GetHint (void)

Returns

Hint text.

SetReadOnly

Sets readonly state of control.

Syntax

void SetReadOnly ([bool ro=true])

Parameters

roreadonly state

Returns

-

GetCaretPos

Gets caret position.

Syntax

int GetCaretPos ()

Returns

Caret position or undefined if edit is not focused.

SetCaretPos

Sets caret position.

Syntax

void SetCaretPos (int pos)

Parameters

rocaret position

Returns

-

Events

OnSetText

OnGetText

OnTextChanged

OnGetAlt

OnGetHint

OnGetClassName

OnKeyDown

OnKeyUp

OnKeyPress

OnMouseEnter

OnMouseLeave

OnFocus

OnBlur

ngPages

This class implements a generic page control.

Syntax

new ngPages ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary
Definition
Pages...
ControlsPanelControls panel definition.
Properties
Page...
PagesVisible...
PagesIndent...
PagesSize...
MaxRows...
PagesAlign...
PagesVAlign...
TextAlign...
HTMLEncode...
Pages...
RowOverlap...
PageImages...
Frame...
Methods
SetPageSets current page index.
GetPageByIdGets page index by page id.
GetIdByPageGets page id by page index.
GetPageObjByIdGets page object by page id.
GetPageByTextGets page index by page text caption.
GetPageByControlGets page index by control placed on page.
GetPageObjByControlGets page object by control placed on page.
SetPageByControlSets page by control placed on page.
Events
OnPageChanging
OnPageChanged
OnGetText
OnGetAlt
OnClick
OnDblClick

Definition

Pages

...  Type: array

ControlsPanel

Controls panel definition.  Type: object

Properties

Page

this.Page

...  Type: int Default value: 0

PagesVisible

this.PagesVisible

...  Type: bool Default value: true

PagesIndent

this.PagesIndent

...  Type: int Default value: 0

PagesSize

this.PagesSize

...  Type: int Default value: 0

MaxRows

this.MaxRows

...  Type: int Default value: 0

PagesAlign

this.PagesAlign

...  Type: string Default value: ’left’

PagesVAlign

this.PagesVAlign

...  Type: string Default value: ’top’

TextAlign

this.TextAlign

...  Type: string Default value: ’center’

HTMLEncode

this.HTMLEncode

...  Type: bool Default value: false

Pages

this.Pages

...  Type: array

RowOverlap

this.RowOverlap

...  Type: int Default value: 0

PageImages

this.PageImages

...  Type: array

Frame

this.Frame

...  Type: object

Methods

SetPage

Sets current page index.

Syntax

void SetPage (mixed page)

Returns

-

GetPageById

Gets page index by page id.

Syntax

int GetPageById (string id)

Returns

Page index or -1 if not found.

GetIdByPage

Gets page id by page index.

Syntax

string GetIdByPage (int page)

Returns

Page id or empty string if not found.

GetPageObjById

Gets page object by page id.

Syntax

object GetPageObjById (string id)

Returns

Page object or null if not found.

GetPageByText

Gets page index by page text caption.

Syntax

int GetPageByText (string text)

Returns

Page index or -1 if not found.

GetPageByControl

Gets page index by control placed on page.

Syntax

int GetPageByControl (object control)

Returns

Page index or -1 if not found.

GetPageObjByControl

Gets page object by control placed on page.

Syntax

int GetPageObjByControl (object control)

Returns

Page object or null if not found.

SetPageByControl

Sets page by control placed on page.

Syntax

bool SetPageByControl (object control)

Returns

TRUE if page was successfuly set.

Events

OnPageChanging

OnPageChanged

OnGetText

OnGetAlt

OnClick

OnDblClick

ngToolBar

This class implements a generic toolbar control.

Syntax

new ngToolBar ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary
Properties
AutoSize...
Vertical...
VPadding...
HPadding...
VAlign...
HAlign...
Wrapable...
Methods
CtrlBringToFrontvoid CtrlBringToFront (object ctrl)
CtrlSendToBackvoid CtrlSendToBack (object ctrl)
CtrlInsertAftervoid CtrlInsertAfter (object ctrl, object whichctrl)
CtrlInsertBeforevoid CtrlInsertBefore (object ctrl, object whichctrl)
Child Controls Properties
ToolBarIgnore...
ToolBarAutoUpdate...
ToolBarIndent...
ToolBarHPadding...
ToolBarVPadding...
ToolBarWidth...
ToolBarHeight...
ToolBarBreak...
ToolBarNoWrap...

Properties

AutoSize

this.AutoSize

...  Type: bool Default value: false

Vertical

this.Vertical

...  Type: bool Default value: false

VPadding

this.VPadding

...  Type: int Default value: 0

HPadding

this.HPadding

...  Type: int Default value: 0

VAlign

this.VAlign

...  Type: string Default value: ’top’

HAlign

this.HAlign

...  Type: string Default value: ’left’

Wrapable

this.Wrapable

...  Type: bool Default value: true

Methods

CtrlBringToFront

Syntax

void CtrlBringToFront (object ctrl)

Parameters

Returns

-

CtrlSendToBack

Syntax

void CtrlSendToBack (object ctrl)

Parameters

Returns

-

CtrlInsertAfter

Syntax

void CtrlInsertAfter (object ctrl, object whichctrl)

Parameters

Returns

-

CtrlInsertBefore

Syntax

void CtrlInsertBefore (object ctrl, object whichctrl)

Parameters

Returns

-

Child Controls Properties

ToolBarIgnore

...  Type: bool Default value: false

ToolBarAutoUpdate

...  Type: bool Default value: true

ToolBarIndent

...  Type: integer Default value: 0

ToolBarHPadding

...  Type: integer Default value: undefined

ToolBarVPadding

...  Type: integer Default value: undefined

ToolBarWidth

...  Type: integer Default value: undefined

ToolBarHeight

...  Type: integer Default value: undefined

ToolBarBreak

...  Type: bool Default value: false

ToolBarNoWrap

...  Type: bool Default value: false

ngProgressBar

This class implements a generic progress bar control.

Syntax

new ngProgressBar ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary
Properties
Position...
Smooth...
LeftImg...
MiddleImg...
RightImg...
BarImg...
Methods
SetPositionSets position of progress in interval 0-100.
BeginProcessStarts waiting animation.
EndProcessEnds waiting animation.

Properties

Position

this.Position

...  Type: int Default value: 0

Smooth

this.Smooth

...  Type: bool Default value: false

LeftImg

this.LeftImg

...  Type: object

MiddleImg

this.MiddleImg

...  Type: object

RightImg

this.RightImg

...  Type: object

BarImg

this.BarImg

...  Type: object

Methods

SetPosition

Sets position of progress in interval 0-100.

Syntax

void SetPosition (int pos)

Returns

-

BeginProcess

Starts waiting animation.

Syntax

void BeginProcess ()

Returns

-

EndProcess

Ends waiting animation.

Syntax

void EndProcess ()

Returns

-

ngWebBrowser

This class implements a web browser control.

Syntax

new ngWebBrowser ([string id])

Parameters

idparent element

See also

Abstract class ngControl.

Summary
Properties
URL...
Methods
SetURLSets browser URL.
GetURLGets browser URL.
SetHTMLSets HTML code directly into browser.
GetBrowserGets browser IFRAME element.
GetDocumentGets browser document object.
Events
OnSetURL
OnGetURL
OnSetHTML

Properties

URL

this.URL

...  Type: string

Methods

SetURL

Sets browser URL.

Syntax

void SetURL (string url)

Returns

-

GetURL

Gets browser URL.

Syntax

string GetURL ()

Returns

The URL.

SetHTML

Sets HTML code directly into browser.

Syntax

void SetHTML (string html [, bool allowdelayed=true])

Returns

-

GetBrowser

Gets browser IFRAME element.

Syntax

object GetBrowser ()

Returns

IFRAME element.

GetDocument

Gets browser document object.

Syntax

object GetDocument ()

Returns

Document object.

Events

OnSetURL

OnGetURL

OnSetHTML

var ngControlsVer
Main version of the Controls framework.
var ngControlsSubVer
Subversion of the Controls framework.
var ngApp
Reference to running ngApplication object.
This class encapsulates web application.
var ngIE6AlignFix
If TRUE, the controls API fixes right align property in IE6.
function ngLang(id,
data,
lng)
Defines resource string/object.
function ngBeginLang(lng)
Begins block of locale definition with id lngid.
function ngTxt(t,
defval)
Gets locale text.
function ngRes(rid)
Gets locale resource object.
function ngGetControlById(id,
type)
Gets control object by ID.
function ngGetControlByElement(elm,
type)
Gets control object by DOM element.
function ng_MergeDef(dst,
def,
allowundefined,
callback)
Merges two control definitions.
function ngCreateControl(d,
ref,
parent)
Creates control by definition.
function ngCreateControlAsType(def,
type,
ref,
parent)
Creates control by definition and type.
obj.ID
Control identificator.
obj.CtrlType
Control type.
obj.CtrlInheritedFrom
Control inheritance info.
obj.BaseClassName
Control CSS base class.
obj.Enabled
Controls whether the control responds to mouse, keyboard.
obj.Visible
Determines whether the control is visible.
obj.Bounds
Specifies the position of the control.
obj.ID
Control identificator.
obj.CtrlType
Control type.
obj.CtrlInheritedFrom
Control inheritance info.
obj.Enabled
Controls whether the control responds to mouse, keyboard.
obj.Elm = function()
Gets access to container DIV element object.
this.AppPath
...
this.Lang
...
this.LocationHash
...
this.MobileKeyboardFix
...
this.Confirm=function(t)
Displays a message with Yes or No buttons to user.
Performs application client parameters update deferred by a call to BeginUpdateParams.
Prevents the updating of application client parameters until the EndUpdateParams method is called.
this.Update = function()
Redraws all controls.
this.Release = function()
Clears all control’s DIV containers.
this.Dispose = function()
Destroys all controls.
this.AddControls = function(defs,
parent)
Adds controls.
This class implements a generic panel control.
this.TextAlign
...
this.AutoSize
...
this.AutoSizeMode
...
this.Text
...
this.Alt
...
this.HTMLEncode
...
this.CanSelect
...
this.Alt
...
this.Img
...
this.AutoSize
...
this.Alt
...
this.Img
...
this.AutoSize
...
this.Shapes
...
this.Text
...
this.Alt
...
this.Visible
Determines whether the control is visible.
this.Action
...
this.Text
...
this.TextAlign
...
this.Alt
...
this.HTMLEncode
...
this.AutoSize
...
this.Checked
...
this.Img
...
this.ImgAlign
...
this.ImgIndent
...
this.LeftImg
...
this.MiddleImg
...
this.RightImg
...
This class implements a generic button control.
this.Text
...
this.HTMLEncode
...
this.Frame
...
this.ControlsInside
...
this.Text
...
this.DefaultText
...
this.TextAlign
...
this.Alt
...
this.Hint
...
this.ReadOnly
...
this.Password
...
this.MaxLength
...
this.LeftImg
...
this.MiddleImg
...
this.RightImg
...
this.OffsetTop
...
this.HasFocus
...
this.SelectOnFocus
...
this.Buttons
...
this.DropDownType
...
this.DropDownControl
...
this.DropDownWidth
...
this.DropDownAlign
...
This class implements a generic edit control.
c.DoUp = function()
Increase value by Step.
...
c.DoDown = function()
Decrease value by Step.
c.GetNum = function()
Gets number.
c.SetNum = function(n)
Sets number.
c.ButtonUp
...
c.ButtonDown
...
this.Text
...
this.DefaultText
...
this.TextAlign
...
this.Alt
...
this.Hint
...
this.ReadOnly
...
this.Frame
...
this.HasFocus
...
this.SelectOnFocus
...
this.Page
...
this.PagesVisible
...
this.PagesIndent
...
this.PagesSize
...
this.MaxRows
...
this.PagesAlign
...
this.PagesVAlign
...
this.TextAlign
...
this.HTMLEncode
...
this.Pages
...
this.RowOverlap
...
this.PageImages
...
this.Frame
...
this.AutoSize
...
this.Vertical
...
this.VPadding
...
this.HPadding
...
this.VAlign
...
this.HAlign
...
this.Wrapable
...
this.Position
...
this.Smooth
...
this.LeftImg
...
this.MiddleImg
...
this.RightImg
...
this.BarImg
...
this.URL
...
This is an abstract class for all visual controls.
Close