TIWCGJQGridNavEditFormOptions Class
Represents type TIWCGJQGridNavEditFormOptions
.
IWCGJQCommon.TIWCGJSon
IWCGJQGrid.TIWCGJQGridNavCommonFormOptions
IWCGJQGrid.TIWCGJQGridNavEditFormOptions
IWCGJQGrid.TIWCGJQGridNavAddFormOptions
type TIWCGJQGridNavEditFormOptions = class(TIWCGJQGridNavCommonFormOptions) end;
The TIWCGJQGridNavEditFormOptions type exposes the following members.
Name | Description | |||
---|---|---|---|---|
![]() | AddCaption | The caption of add form
| ||
![]() | AddedRow | Controls where the row just added is placed: 'first' at the top of the gird, 'last' at the bottom. Where the new row is to appear in its natural sort order, set reloadAfterSubmit: true | ||
![]() | AjaxEditOptions | This option allow to set global ajax settings for the form editiing when we save the data to the server. Note that with this option is possible to overwrite all current ajax setting in the save request including the complete event. | ||
![]() | BCancel | The caption of cancel button
| ||
![]() | BClose | The caption of close button
| ||
![]() | BExit | The caption of exit button
| ||
![]() | BNo | The caption of NO button
| ||
![]() | BottomInfo | When set this information is placed just after the buttons of the form as additional row | ||
![]() | BSubmit | The caption of submit button
| ||
![]() | BYes | The caption of Yes button
| ||
![]() | CGJSContainer | Represents property | ||
![]() | CheckOnSubmit | This option work only in editing mode. If Set to true this option will work only when a submit button is clicked and if any data is changed in the form. If the data is changed a dilog message appear where the user is asked to confirm the changes or cancel it. Pressing cancel button of the new dialog will return to the form, but does not set the values to its original state. | ||
![]() | CheckOnUpdate | This option is applicable in add and edit mode. When this option is set to true the behaviour as follow: when something is changed in the form and the user click on Cancel button, navigator buttons, close button (on upper right corner of the form), in overlay (if available) or press Esc key (if set) a message box appear asking the user to save the changes, not to save the changes or go back in the grid cancel all changes (this will close the modal form) | ||
![]() | ClassData | Represents property | ||
![]() | ClearAfterAdd | when add mode, clear the data after adding data | ||
![]() | CloseAfterAdd | when add mode, close the dialog after add record | ||
![]() | CloseAfterEdit | when in edit mode, close the dialog after editing | ||
![]() | CloseIcon | Determines the icon of the cancel button. The default values are [true,”left”,”ui-icon-close”]. For description of these see saveicon | ||
![]() | CloseOnEscape | When set to true the modal window can be closed with ESC key from the user. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | DataHeight | the parameter control the scrolling content - i.e between the modal header and modal footer. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | DataWidth | Represents property | ||
![]() | Drag | Determines if the dialog is dragabale. Works only if jqDnR plugin is present or if the dragable widget is present from jQuery UI (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | EditCaption | The caption of edit form | ||
![]() | EditData | an array used to add content to the data posted to the server | ||
![]() | Grid | Represents property | ||
![]() | Height | the entry height of confirmation dialog (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | InstList | Represents property | ||
![]() | IsStored | Represents property | ||
![]() | jqModal | If set to true uses jqModal plugin (if present) to creat the dialogs. If set to true and the plugin is not present jqGrid uses its internal function to create dialog. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | JSon | Return the Interface of SuperObject (ISuperObject) (Inherited from TIWCGJSon.) | ||
![]() | JSonEvents[string] | Represents property | ||
![]() | Left | the initial left position of modal dialog. The default value of 0 mean the left position from the upper left corner of the grid. When jqModal option is true (see below) and jqModal plugin is present any value different from 0 mean the left position from upper left corner of the window. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | List | Represents property | ||
![]() | MemberList | Represents property | ||
![]() | Modal | determines if the dialog will be modal. Also works only if jqModal plugin is present. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | Msg | The messages validations
| ||
![]() | MType | Defines the type of request to make (“POST” or “GET”) when data is sent to the server | ||
![]() | NavKeys | This option works only in edit mode and add keyboard navigation, which allow us to navigate through the records while in form editing pressing certain keys. The default state is disabled. The first item enables/disables the navigation. The second item corresponds to reccord up and by default is the the key code for Up key. The third item corresponds to reccord down and by default is the key code for Down key | ||
![]() | OnAfterClickPgButtons | This event can be used only when we are in edit mode and the navigator buttons are enabled; it fires after the data for the new row is loaded from the grid, allowing modification of the data or form before the form is redisplayed. afterclickPgButtons : function(whichbutton, formid, rowid) where whichbutton is either 'prev' or 'next' formid is the jQuery object of form id, you can use formid[0].id to get form id. rowid is the id of the current row | ||
![]() | OnAfterComplete | This event fires immediately after all actions and events are completed and the row is inserted or updated in the grid. afterComplete : function (response, postdata, formid) {…} where response is the data returned from the server (if any) postdata an array, is the data sent to the server formid is the jQuery object of form id, you can use formid[0].id to get form id. | ||
![]() | OnAfterShowForm | fires after showing the form; receives as Parameter the id of the constructed form. afterShowForm : function (formid) {…} | ||
![]() | OnAfterSubmit | fires after response has been received from server. Typically used to display status from server (e.g., the data is successfully saved or the save cancelled for server-side editing reasons). Receives as parameters the data returned from the request and an array of the posted values of type id=value1,value2. When used this event should return array with the following items [success, message, new_id] where success is a boolean value if true the process continues, if false a error message appear and all other processing is stopped. (message is ignored if success is true). new_id can be used to set the new row id in the grid when we are in add mode. afterSubmit : function(response, postdata) { … return [success,message,new_id] } | ||
![]() | OnBeforeCheckValues | This event fires before checking the values (if checking is defined in colModel via editrules option). To this event we pass the following parameters: 1. posdata - the array of values which should be chaced in name:value pair, where the name is the name from colModel. 2. formid - the form id object. 3. mode - the current mode in which we are - can be add or edit. In all cases the event should return object in name value pair which then will be posted to the server. | ||
![]() | OnBeforeInitData | fires before initialize the new form data. Receives, as parameter, the id of the constructed form. beforeInitData : function(formid) {…} | ||
![]() | OnBeforeShowForm | fires before showing the form with the new data; receives as Parameter the id of the constructed form. beforeShowForm : function(formid) {…} (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | OnBeforeSubmit | fires before showing the form with the new data; receives as Parameter the id of the constructed form. beforeShowForm : function(formid) {…} | ||
![]() | OnClickPgButtons | fires before the data is submitted to the server. Recieves as parameter the posted data array and the formid. beforeSubmit : function(postdata, formid) { … return[success,message]; } When defined this event should return array with the following values success boolean indicating if the proccess should continue (true) or a error (false) message should appear to the user | ||
![]() | OnClickSubmit | fires after the submit button is clicked and the postdata is constructed. Parameters passed to this event are: a options array of the method and the posted data array. The event should return array of type {} which extends the postdata array. onclickSubmit : function(params, posdata) { … return {add_data} } | ||
![]() | OnClose | This event is called just before closing the form and when a close icon is clicked, a cancel button is clicked, ESC key is pressed or click on overlay (if jqModal is present). The event can return (optionally) true or false. If the return value is true the form is closed, if false the form does not close. If nothing is returned the form is closed (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | OnErrorTextFormat | The event (can) fire when error occurs from the ajax call and can be used for better formatting of the error messages. To this event is passed response from the server. The event should return single message (not array), which then is displayed to the user. | ||
![]() | OnInitializeForm | fires only once when creating the data for editing and adding. Receives, as parameter, the id of the constructed form. onInitializeForm : function(formid) {…} | ||
![]() | OnSerializeEditData | If set this event can serialize the data passed to the ajax request when we save a form data. The function should return the serialized data. This event can be used when a custom data should be passed to the server - e.g - JSON string, XML string and etc. To this event is passed the data which will be posted to the server | ||
![]() | Owner | Represents property | ||
![]() | PropCount | Represents property | ||
![]() | PropIndexByName[string] | Represents property | ||
![]() | PropList | Represents property | ||
![]() | PropName | Represents property | ||
![]() | PropNameByIndex[Integer] | Represents property | ||
![]() | RecreateForm | when set to true the form is recreated every time the dialog is activeted with the new options from colModel (if they are changed) | ||
![]() | ReloadAfterSubmit | reload grid data after posting | ||
![]() | Resize | determines if the dialog can be resized. Works only is jqDnR plugin is available or resizable widget is present from jQuery UI. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | SaveData | The confirmation message on save
| ||
![]() | SaveIcon | Determines the icon of the submit button. The default value is [true,”left”,”ui-icon-disk”]. The first item enables/disables the icon. The second item tells where to put the icon to left or to right of the text. The third item corresponds to valid ui icon from theme roller | ||
![]() | SaveKeys | Determines the possibility to save the form with pressing a certain key.The first item enables/disables saving with pressing certain key. The second item corresponds to key code for saving. If enabled the default value for saving is [Enter]. Note that this binding should be used for both adding and editing a row. Since the binding is for the form, there is no possibility to have one key in add and another in edit mode. | ||
![]() | SObj | Represents property | ||
![]() | Top | the initial top position of modal dialog. The default value of 0 mean the top position from the upper left corner of the grid. When jqModal option is true (see below) and jqModal plugin is present any value different from 0 mean the top position from upper left corner of the window. (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | TopInfo | When set this information is placed just after the modal header as additional row | ||
![]() | Url | url where to post data. If set, replaces the editurl | ||
![]() | ViewPagerButtons | This option enable or disable the appearing of the previous and next buttons (pager buttons) in the form | ||
![]() | Width | the width of confirmation dialog (Inherited from TIWCGJQGridNavCommonFormOptions.) | ||
![]() | zIndex | The starting z-index for the dialog. If you will see the dialog form under another elements or dialogs you should use the parameter with some value higher as default value 950. In the most cases it should be the value higher as 1000 - the default value of jQuery UI dialog. (Inherited from TIWCGJQGridNavCommonFormOptions.) |
Name | Description | |||
---|---|---|---|---|
![]() | AddBooleanMember(string,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddColorMember(string,TIWCGColor,Boolean,Boolean) | Represents method | ||
![]() | AddCurrencyMember(string,Currency,Boolean,Boolean) | Represents method | ||
![]() | AddDoubleMember(string,Double,Boolean,Boolean) | Represents method | ||
![]() | AddDynObjListMember(string,Boolean,Boolean) | Represents method | ||
![]() | AddEnumMember(string,string[],Byte,Boolean,Boolean) | Represents method | ||
![]() | AddEnumSetMember(string,string[],Void,Word,Boolean,Boolean) | Represents method | ||
![]() | AddFuncMember(string,string,string,Boolean,TIWCGJSonFuncClass,Boolean,Boolean) | Represents method | ||
![]() | AddHTML5(TIWHTMLTag) | Represents method | ||
![]() | AddIntegerMember(string,Integer,Boolean,Boolean) | Represents method | ||
![]() | AddJSonMember(string,TCGJSon,Boolean,Boolean) | Represents method | ||
![]() | AddMembers | The procedure add jquery properties.
| ||
![]() | AddObjListMember(string,TIWCGJSonListClass,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddObjMember(string,TIWCGJSonClass,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddSimpleArrayMember(string,Boolean,Boolean,Boolean) | Represents method | ||
![]() | AddStringMember(string,string,Boolean,Boolean) | Represents method | ||
![]() | AddVariantMember(string,Variant,Boolean,Boolean) | Represents method | ||
![]() | AfterConstruction | Represents method | ||
![]() | Assign(TPersistent) | Represents method | ||
![]() | CheckJSonMember(Integer) | Represents method | ||
![]() | ConvertEnumToString(string) | Represents method | ||
![]() | ConvertSetToString(string,TCGStringArray) | Represents method | ||
![]() | FreeJSonObj(Integer) | Overloaded. Represents method | ||
![]() | FreeJSonObj(string) | Overloaded. Represents method | ||
![]() | GetBooleanValue(Integer) | Represents method | ||
![]() | GetCGJSContainer | Represents method | ||
![]() | GetColorValue(Integer) | Represents method | ||
![]() | GetCurrencyValue(Integer) | Represents method | ||
![]() | GetCustomJq(string,ISuperObject) | Represents method | ||
![]() | GetDoubleValue(Integer) | Represents method | ||
![]() | GetDynObjListValue(Integer) | Represents method | ||
![]() | GetEnumAsString(Integer) | Represents method | ||
![]() | GetEnumerValue(Integer) | Represents method | ||
![]() | GetEnumSetValue(Integer,Pointer) | Represents method | ||
![]() | GetFixedScript(TIWCGJSonFunc,Boolean) | Represents method | ||
![]() | GetFuncValue(Integer) | Represents method | ||
![]() | GetHTMLName | Represents method | ||
![]() | GetImplComponent | Represents method | ||
![]() | GetIntegerValue(Integer) | Represents method | ||
![]() | GetIsStored | Represents method | ||
![]() | GetItemIndex | Represents method | ||
![]() | GetIWCLName | Represents method | ||
![]() | GetJSon | Represents method | ||
![]() | GetJSonByType(Boolean,Boolean) | Represents method | ||
![]() | GetJSonEx(Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
![]() | GetJSonValue(Integer) | Represents method | ||
![]() | GetJSonValueObj(Integer) | Represents method | ||
![]() | GetMemberJSon(TCGJSonMember,ISuperObject,Boolean,Boolean,string) | Represents method | ||
![]() | GetMemberSetterHandler(TObject,TCGJSonMember) | Represents method | ||
![]() | GetMemberSetterScriptParts(TIWCGResponseMemberList,TIWCGJScript) | Represents method | ||
![]() | GetMembersJSon(TIWCGResponseMemberList,Boolean,Boolean) | Represents method | ||
![]() | GetObjListValue(Integer) | Represents method | ||
![]() | GetObjValue(Integer) | Represents method | ||
![]() | GetOwner | Represents method | ||
![]() | GetPropName | Represents method | ||
![]() | GetSimpleArrayValue(Integer) | Represents method | ||
![]() | GetStringValue(Integer) | Represents method | ||
![]() | GetVariantValue(Integer) | Represents method | ||
![]() | InternalGetJSon(TEachPropJSonProc,Boolean,Boolean,Void,Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
![]() ![]() | IsArray | Represents method | ||
![]() | IsBooleanStored(Integer) | Represents method | ||
![]() | IsColorStored(Integer) | Represents method | ||
![]() | IsCurrencyStored(Integer) | Represents method | ||
![]() | IsDoubleStored(Integer) | Represents method | ||
![]() | IsEnumerStored(Integer) | Represents method | ||
![]() | IsEnumSetStored(Integer) | Represents method | ||
![]() | IsFuncStored(Integer) | Represents method | ||
![]() | IsIntegerStored(Integer) | Represents method | ||
![]() | IsJSonObjStored(string) | Represents method | ||
![]() | IsJSonStored(Integer) | Represents method | ||
![]() | IsObjStored(Integer) | Represents method | ||
![]() | IsStringStored(Integer) | Represents method | ||
![]() | IsVariantStored(Integer) | Represents method | ||
![]() ![]() | JSonEscape | Represents method | ||
![]() ![]() | JSonIdent | Represents method | ||
![]() ![]() | JSonNameQuote | Represents method | ||
![]() | ResetProps | Represents method | ||
![]() | SetBooleanValue(Integer,Boolean) | Represents method | ||
![]() | SetColorValue(Integer,TIWCGColor) | Represents method | ||
![]() | SetCurrencyValue(Integer,Currency) | Represents method | ||
![]() | SetDoubleValue(Integer,Double) | Represents method | ||
![]() | SetDynObjListValue(Integer,TIWCGJSonDynObjList) | Represents method | ||
![]() | SetEnumerValue(Integer,Byte) | Represents method | ||
![]() | SetEnumSetValue(Integer,Pointer) | Represents method | ||
![]() | SetFuncValue(Integer,TIWCGJSonFunc) | Represents method | ||
![]() | SetIntegerValue(Integer,Integer) | Represents method | ||
![]() | SetJSonValue(Integer,TCGJSon) | Represents method | ||
![]() | SetObjListValue(Integer,TIWCGJSonList) | Represents method | ||
![]() | SetObjValue(Integer,TIWCGJSon) | Represents method | ||
![]() | SetSimpleArrayValue(Integer,TIWCGJSonSimpleArray) | Represents method | ||
![]() | SetStringValue(Integer,string) | Represents method | ||
![]() | SetVariantValue(Integer,Variant) | Represents method | ||
![]() | StoreProperty(PPropInfo,TObject) | Represents method | ||
![]() | SupportsSetter(TObject,TCGJSonMember) | Represents method |