diff --git a/.gitignore b/.gitignore index 2f57bdc5f1..51612ac868 100644 --- a/.gitignore +++ b/.gitignore @@ -66,5 +66,13 @@ environment_log.txt # Documentation # ################# -Documentation/html_viewer/resources/data/api/*.js +Documentation/html_viewer/resources/data/api*/*.js Documentation/html_viewer/resources/data/guide/*.js + +# Additional externals # +######################## +Ext/ + +# Edition file # +################ +edition.txt diff --git a/.mention-bot b/.mention-bot new file mode 100644 index 0000000000..1c94340c51 --- /dev/null +++ b/.mention-bot @@ -0,0 +1,3 @@ +{ + "requiredOrgs": ["livecode"] +} diff --git a/Documentation/Docs Helper.livecode b/Documentation/Docs Helper.livecode new file mode 100644 index 0000000000..54dbd95582 Binary files /dev/null and b/Documentation/Docs Helper.livecode differ diff --git a/Documentation/GlossaryQuickRef b/Documentation/GlossaryQuickRef deleted file mode 100644 index 97be21fbe9..0000000000 --- a/Documentation/GlossaryQuickRef +++ /dev/null @@ -1 +0,0 @@ -activate,activated,activates,activating,/232.xml .aiff,.aiffs,.aiff's,.aiffs',AIFF,aiffs,aiff's,aiffs',/335.xml alias,aliases,alias's,aliases',aliased,aliasing,/271.xml alpha,/426.xml alphanumeric,alphanumeric,alpha-numeric,/317.xml altkey,altkeys,altkey's,altkeys',alt,Alt-key,Alt-key's,/448.xml GIF,/15.xml bug,bugs,bug's,bugs',buggy,anomalous,anomaly,anomalies,anomaly's,anomalies',/546.xml antialiasing,antialias,antialiased,anti-aliasing,anti-alias,anti-aliased,/531.xml look,lookAndFeel,appearance,appearances,appearance's,appearances',/288.xml appending,appends,appended,append,/297.xml AppleEvent,AppleEvents,AppleEvent's,AppleEvents',/457.xml AppleScript,AppleScript's,/381.xml AppleTalk,AppleTalk's,/507.xml application,applications,application's,applications',/92.xml bundle,bundles,bundle,bundles,bundle's,bundles',/212.xml Aqua,Aqua's,/48.xml argument,arguments,argument's,arguments',/97.xml armed,arms,arming,arm,/395.xml arrays,array,array's,arrays',/412.xml ASCII,ASCII,/50.xml attribute,attributes,attribute's,attributes',/383.xml .au,.aus,.au's,.aus',mulaw,mu-law,law,-law,AU,aus,au's,aus',/319.xml audioclip,audioclips,audioclip's,audioclips',/44.xml .avi,.avis,.avi's,.avis',AVI,AVIs,AVI's,AVIs',/289.xml backgrounds,background,background's,backgrounds',/430.xml backScript,backScripts,backScript's,backScripts',backScript,/244.xml feel,behavior,/240.xml binary,/64.xml binaries,binaries',/520.xml hqx,.hqx,BinHex,binhexed,binhexing,binhexes,/78.xml bits,bit's,bits',bit,/154.xml bitwise,bit-wise,/527.xml BLOB,BLOBs,BLOB's,BLOBs',/407.xml blocking,block,blocks,blocked,/153.xml bmps,bmp's,bmps',.bmp,.bmps,.bmp's,.bmps',BMP,/125.xml true,false,boolean,booleans,boolean's,booleans',/295.xml breakpoint,breakpoints,breakpoint's,breakpoints',/312.xml browse,browsing,browsed,browses,/469.xml buffers,buffered,buffering,buffer,buffer's,buffers',/290.xml build,building,builds,built,builder,builders,builder's,builders',/369.xml button,buttons,button's,buttons',/298.xml byte,bytes,byte's,bytes',/4.xml cache,cached,caching,caches,cache's,caches',/254.xml call,calls,called,calling,call's,calls',/186.xml callback,callbacks,callback's,callbacks',/393.xml caller,callers,caller's,callers',/434.xml Carbon,Carbon's,/473.xml card,cards,card's,cards',/390.xml cascading,submenu,submenus,submenu's,submenus',/171.xml insensitivity,insensitive,case-insensitivity,case-insensitive,/43.xml sensitivity,sensitive,case-sensitivity,case-sensitive,/279.xml cell,cells,cell's,cells',/265.xml CGI,CGI,CGIs,CGI's,CGIs',/241.xml channel,channels,channel's,channels',/426.xml char,character,characters,character's,characters',/317.xml checkbox,checkboxes,checkbox's,checkboxes',/215.xml checksum,checksums,checksum's,checksums',checksummed,checksumming,/494.xml chunk,chunks,chunk's,chunks',chunking,/470.xml clipboard,clipboard's,/367.xml codec,codecs,codec's,codecs',/131.xml collapse,collapses,collapsing,collapsed,collapsation,/41.xml WindowShade,collapse,/419.xml column,columns,column's,columns',/303.xml combo,combobox,comboboxes,combobox's,comboboxes',/249.xml commands,command's,commands',command,/397.xml comment,comment's,comments',commented,commenting,uncomment,uncomments,uncommented,uncommenting,remark,/475.xml compiling,compilation,compile,compiled,compiles,compiles,compile's,compiles',recompiling,recompilation,recompile,recompiled,recompiles,compiler,compilers,compiler's,coompilers',uncompiled,/551.xml compression,compressing,compressed,compresses,compress,/3.xml concatenation,concatenating,concatenated,concatenate,concatenates,/487.xml if,/516.xml constants,constant's,constants',constant,/505.xml constrain,constraint,constraints,constraint's,constraints',constrained,constrains,constraining,/293.xml containers,container's,containers',container,/349.xml discontiguous,contiguous,contiguity,/103.xml controls,control's,controls',control,widget,widgets,widget's,widgets',/410.xml structure,structures,structure's,structures',/456.xml creator,creators,creator's,creators',/411.xml crossplatform,cross-platform,/84.xml cursors,cursor's,cursors',cursor,/440.xml Darwin,Darwin's,/120.xml datafork,dataforks,datafork's,dataforks',/332.xml database,databases,database's,databases',/90.xml datagram,datagrams,datagram's,datagrams',/7.xml debugging,debug,debugs,debugged,/31.xml debugger,debuggers,debugger's,debuggers',/162.xml decimal,decimals,/8.xml declaration,declarations,declaration's,declarations',declaring,declared,declares,declare,declare's,declares',/113.xml decoding,decoding's,decodings,decodings',decoded,decodes,decode,/213.xml decryption,decryption's,decrypting,decrypted,decrypts,decrypt,/342.xml defaults,default's,defaults',default,/36.xml degrees,degree's,degrees',degree,/160.xml delimiting,delimited,delimits,delimit,/159.xml delimiters,delimiter's,delimiters',delimiter,/181.xml dereference,dereferencing,dereferences,dereferenced,/192.xml desktop,desktops,desktop's,desktops',/77.xml development,/225.xml dialog,dialogs,dialog's,dialogs',/232.xml dimmed,dim,dimming,dims,grayed-out,/218.xml disable,disabled,disabling,disables,host,ghosted,/400.xml disclosure,/464.xml dithers,dithering,dithered,dither,/264.xml DLLs,DLL's,DLLs',DLL,/321.xml DNS,DNS's,/227.xml dock,dock's,docked,/388.xml documents,document's,documents',document,/482.xml domain,domains,domain's,domains',/445.xml double-byte,/86.xml downloads,downloading,downloaded,download,download's,downloads',/219.xml drag,drop,drag-and-drop,drag,/32.xml drawer,drawers,drawer's,drawers',/239.xml DSN,DSNs,DSN's,DSNs',/334.xml DTD,DTDs,DTD's,DTDs',/179.xml element,elements,element's,elements',/123.xml Emacs,Emacs's,/132.xml encoded,encodes,encoding,encodings,encoding's,encodings',encode,/263.xml encryption,encryptions,encryption's,encryptions',encrypts,encrypting,encrypted,encrypt,/500.xml engine,engines,engine's,engines',/202.xml EOF,EOF's,/25.xml eon,eons,eon's,eons',aeon,aeons,aeon's,aeons',/27.xml EPS,EPSs,EPS's,EPSs',/476.xml error,errors,error's,errors',/76.xml escape,esc,/124.xml evaluation,evaluating,evaluated,evaluates,evaluate,/104.xml events,event's,events',event,/457.xml execution,executing,executes,executed,execute,/276.xml error,/107.xml exits,exiting,exited,exit,exit's,/145.xml exporting,exported,exports,export,/323.xml expressions,expression's,expressions',expression,/135.xml extension,extensions,extension's,extensions',extension,/106.xml external,externals,external's,externals',/183.xml factors,factor's,factors',factor,/98.xml field,fields,field's,fields',field,/161.xml file,files,files',file,file's,/194.xml pathname,pathnames,pathname's,pathnames',path,paths,path's,paths',/194.xml firewall,firewalls,firewalled,firewalling,/540.xml flags,flag's,flags',flag,/423.xml focusing,focussing,focused,focussed,focuses,focusses,focus,/548.xml folder,folders,folder's,folders',directory,directory's,directories,directories',/194.xml fonts,font's,fonts',font,/49.xml formatted,formatting,formats,format's,formats',format,/256.xml frames,frame's,frames',frame,/201.xml frontscripts,frontscript's,frontscripts',frontScript,/195.xml FTP,FTP's,/9.xml functions,function,function's,functions',/42.xml gamma,gammas,gamma's,gammas',/471.xml geometry,/243.xml getProp,/403.xml GIF,GIFs,GIF's,GIFs',/15.xml global,globals,global's,globals',globally,/376.xml graphic,graphics,graphic's,graphics',/222.xml greedy,greediness,greedy's,/188.xml groups,group's,groups',group,grouping,grouped,/164.xml handle,handles,handled,handling,/365.xml handlers,handler's,handlers',handler,/365.xml hex,hexadecimal,hexadecimals,/144.xml hilite,hilites,hilited,hiliting,highlite,highlites,highlited,highliting,hilight,hilights,hilighted,hilighting,highlight,highlights,highlighted,highlighting,unhilite,unhilites,unhilited,unhiliting,unhighlite,unhighlites,unhighlited,unhighliting,unhilight,unhilights,unhilighted,unhilighting,unhighlight,unhighlights,unhighlighted,unhighlighting,/163.xml hosts,host's,hosts',host,/74.xml HTML,HTML's,/391.xml HTTP,HTTP's,/320.xml HyperTalk,HyperTalk's,HC,HC's,HT,HT's,HyperCard,HyperCard's,/401.xml hypermedia,hypermedia's,hypertext,hypertext's,/370.xml iconifies,iconification,iconified,iconify,iconifying,/93.xml IDE,IDE's,/535.xml idle,idling,idle-time,idle,/379.xml images,image,image's,images',/335.xml imported,imports,importing,import,/253.xml inherit,inheriting,inherits,inherited,inheritance,inheritances,inheritance's,inheritances',owner's,/459.xml integer,integers,integer's,integers',/491.xml inverse,inverses,inverse's,inverses',/176.xml IP,TCP,/221.xml ISO,ISO-8859,ISO-8859's,ISO-8859-1,ISO-8859-1',ISO-Latin,ISO-Latin',/52.xml items,item's,items',item,/139.xml iterate,iterates,iterating,iterated,iteration,iterations,iteration's,iterations',/196.xml JPEG,JPEGs,JPEG's,JPEGs',JPG,JPGs,JPG's,JPGs',.jpeg,.jpegs,.jpeg's,.jpegs',.jpg,.jpgs,.jpg's,.jpgs',/344.xml index,indexes,index's,indexes',indices,indices',key,keys,key's,keys',/448.xml shortcut,/127.xml keycode,keycodes,keycode's,keycodes',/116.xml keyword,keywords,keyword's,keywords',/122.xml landscape,landscape,/111.xml launches,launched,launching,launch,launch's,launches',/287.xml layers,layer's,layers',layer,/486.xml libraries,library,libraries',library's,/18.xml line,lines,line's,lines',/87.xml literal,literal,literals,literal's,literals',/385.xml loaded,loading,loads,load,/219.xml locked,locks,locking,lock,/475.xml true,false,logical,Boolean,/511.xml repeat,loops,loop's,loops',looping,loop,looped,/418.xml lossless,lossless,/79.xml lossy,lossy,/343.xml Mac,Macs,Mac's,Macs',Macintosh,Macintoshes,Macintosh's,Macintoshes',MacOS,MacOS's,/468.xml MacBinary,/223.xml mainstack,mainstacks,mainstack's,mainstacks',/258.xml masked,masks,mask's,masks',mask,/433.xml unmatched,matched,matching,/499.xml maximized,maximizing,maximizes,maximize,/169.xml menu,menus,menu's,menus',/294.xml menubar,menubars,menubar's,menubars',/485.xml menuitem,menuitems,menuitem's,menuitems',/146.xml message,messages,message's,messages',message,/44.xml handler,/305.xml MetaTalk,MT,MC,MetaCard,MetaTalk's,MT's,MC's,MetaCard's,/338.xml metal,metal's,metallic,/322.xml milliseconds,millisecond's,milliseconds',millisecond,/45.xml MIME,MIME-encoding,MIME-encoded,MIME,/89.xml minimizing,minimizes,minimized,minimize,/85.xml modal,modals,modal's,modals',/357.xml modeless,modelesses,modeless's,modelesses',non-modal,non-modal's,nonmodal,nonmodal's,/193.xml Motif,Motif's,/394.xml pointer,pointers,pointer's,pointers',/296.xml movie,movies,movie's,movies',/112.xml MPEG,mpegs,mpeg's,mpegs',mpg,mpgs,mpg's,mpgs',/377.xml navigation,/134.xml negative,/156.xml nesting,nested,nest,nests,/521.xml NNTP,NNTP's,/408.xml node,nodes,node's,nodes',/69.xml nulls,null's,nulls',null,/128.xml numerical,numeric,/317.xml objects,object,object's,objects',/44.xml hierarchy,/136.xml descriptor,descriptors,descriptor's,descriptors',reference,references,reference's,references',/208.xml classes,class's,classes',class,/117.xml octal,octals,/58.xml offsets,offset's,offsets',offset,/180.xml ODBC,ODBC,ODBC's,/447.xml OSA,OSA's,/150.xml operands,operand's,operands',operand,/364.xml operations,operation's,operations',operation,/90.xml operators,operator's,operators',operator,/348.xml OMO,/72.xml ordinals,ordinal's,ordinals',ordinal,/189.xml OSX,OSX's,/427.xml owner,owners,owner's,owners',owned,owning,own,owns,parent,parents,parent's,parents',/405.xml pads,padded,padding,pad,/187.xml palette,palettes,palette's,palettes',windoid,windoid's,windoids,windoids',/285.xml pane,panes,pane's,panes',/428.xml panel,panels,panel's,panels',/417.xml parameter,parameters,parameter's,parameters',parameter,/155.xml pass,passed,passing,passes,/46.xml password,passwords,password's,passwords',passphrase,passphrases,passphrase's,passphrases',/96.xml PBM,PBMs,PBM's,PBMs',.pbm,.pbms,.pbm's,.pbms',/182.xml peripheral,peripheral,peripherals,peripheral's,peripherals',device,devices,device's,devices',/398.xml .pgm,.pgms,.pgm's,.pgms',PGM,PGMs,PGM's,PGMs',/255.xml PICTs,PICT's,PICTs',PICT,/185.xml pixels,pixel's,pixels',pixel,/462.xml pixmaps,pixmap's,pixmaps',pixmapped,pixmap,pix-maps,pix-map's,pix-maps',pix-mapped,pix-map,/55.xml platforms,platform's,platforms',platform,/84.xml Platinum,Platinum's,/458.xml player,players,player's,players',/282.xml plist,plists,plist's,plists',/39.xml plugin,plugins,plugin's,plugins',plug-in,plug-ins,plug-in's,plug-ins',/346.xml .png,.pngs,.png's,.pngs',PNG,PNGs,PNG's,PNGs',/479.xml point,points,point's,points',pointing,pointed,/312.xml poll,polls,polling,polled,/442.xml polygons,polygon's,polygons',polygon,/101.xml POP,POP's,/503.xml popup,popups,popup's,popups',/30.xml ports,port's,ports',port,ported,porting,/323.xml portrait,portrait,/330.xml PostScript,PostScript's,/436.xml PPM,PPMs,PPM's,PPMs',.PPM,.PPMs,.PPM's,.PPMs',/523.xml precedence,precedence's,/109.xml precision,/105.xml prepend,prepended,prepends,prepending,/262.xml pretty-printing,pretty-print,pretty-printed,/62.xml printable,/130.xml processes,process,processes',process's,/317.xml prompts,prompt's,prompts',prompt,prompted,prompting,/61.xml properties,property,property's,properties',/267.xml profile,profiles,profile's,profiles',/250.xml protocols,protocol's,protocols',protocol,/517.xml proxy,proxies,proxy's,proxies',/137.xml QT,QTI,QuickTime,QT's,QTI's,QuickTime's,/351.xml quoted,/542.xml radian,radians,radian's,radians',/481.xml radio,/524.xml randomize,randomized,random,randomly,/63.xml ranges,range's,ranges',range,/119.xml readonly,read-only,/71.xml REALbasic,REALbasic's,/399.xml record,records,record's,records',row,rows,row's,rows',/95.xml rectangle,rectangles,rectangle's,rectangles',/88.xml recursion,recurse,recurses,recursed,recursing,recursive,/378.xml redrawn,redrawing,redraws,redrew,redraw,/273.xml registries,registry,registry's,/34.xml regex,regexes,regex's,regexes',regexp,regexps,regexp's,regexps',/133.xml coordinates,/100.xml remainders,remainder's,remainders',remainder,/184.xml ResEdit,/142.xml reserved,/257.xml resets,resetting,reset,/151.xml resources,resource,resource's,resources',/194.xml fork,/425.xml resuming,resumes,resumed,resume,/73.xml return,returning,returns,returned,return,/22.xml RTF,RTFs,RTF's,RTFs',/51.xml runtime,run-time,/269.xml scope,scopes,scope's,scopes',scoped,scoping,/65.xml script,scripts,script's,scripts',/546.xml scrollbar,scrollbars,scrollbar's,scrollbars',/455.xml thumb,thumbs,thumb's,thumbs',elevator,elevators,elevator's,elevators',/121.xml selecting,selects,selected,select,/149.xml selection,selections,selection's,selections',/281.xml servers,server's,servers',server,/137.xml setProp,/229.xml sheet,sheets,sheet's,sheets',/514.xml shells,shell's,shells',shelled,shell,shelling,/353.xml shortcut,shortcuts,shortcut's,shortcuts',/354.xml sibling,/204.xml signs,sign's,signs',sign,/411.xml SMTP,SMTP's,/347.xml SOAP,SOAP's,/216.xml sockets,socket's,sockets',socket,/175.xml sorted,sorting,sorts,sort,/99.xml Speech,/536.xml SQL,SQL's,/148.xml query,queries,query's,queries',/242.xml stacks,stacks',stack,stack's,/552.xml standalone,standalones,standalone's,standalones',exe,exes,exe's,exes',.exe,.exes,.exe's,.exes',executable,executables,executable's,executables',/333.xml stderr,stderr's,/261.xml stdin,stdin's,/81.xml stdout,stdout's,/466.xml statements,statement's,statements',statement,/200.xml streaming,stream,streams,streamed,/12.xml strings,string's,strings',string,/385.xml subdirectory,subdirectories,subdirectory's,subdirectories',subfolder,subfolders,subfolder's,subfolders',/6.xml subroutines,subroutine's,subroutines',subroutine,/16.xml substacks,substack's,substacks',substack,/13.xml SuperTalk,ST,SC,SuperCard,SuperTalk's,ST's,SC's,SuperCard's,/5.xml suspended,suspends,suspending,suspend,/329.xml symlink,syminks,symlink's,symlinks',symlinked,symlinking,softlink,softlinks,softlink's,softlinks',softlinked,softlinking,/230.xml synchronized,synchronizing,synchronizes,sync,syncing,synced,syncs,synchronize,/291.xml syntactical,syntaxes,syntax,syntaxes',syntax's,/29.xml tabstop,tabstops,tabstop's,tabstops',/205.xml tabbed,/358.xml table,tables,table's,tables',/220.xml tag,tags,tag's,tags',/7.xml taskbar,taskbar's,/331.xml TCP,TCP's,TCPIP,TCPIP's,TCP,/409.xml templates,template's,templates',template,/368.xml text-to-speech,text-to-speech's,speech,/280.xml ticks,tick's,ticks',tick,/66.xml timeouts,timeout's,timeouts',timeout,/549.xml timestamps,timestamp's,timestamps',timestamp,/325.xml titlebar,titlebars,titlebar's,titlebars',/199.xml token,tokens,token's,tokens',/67.xml tool,tools,tool's,tools',/537.xml tooltip,tooltips,tooltip's,tooltips',/314.xml Transcript,Transcript's,/546.xml trap,traps,trapped,trapping,/363.xml triggered,triggering,triggers,trigger,/231.xml tween,tweened,tweens,tweening,tweening's,/386.xml signature,/446.xml unary,/415.xml uncompressed,uncompresses,uncompressing,uncompress,decompressed,decompresses,decompressing,decompress,/238.xml undoing,undoes,undid,undo,/158.xml Unicode,Unicode's,/19.xml Unices,Unixes,Unices',Unixes',Linux,Linuxes,Linux's,Unix,Unix's,/444.xml unlocked,unlocking,unlocks,unlock,/360.xml uploads,upload's,uploads',uploaded,uploading,upload,/492.xml URLs,URL's,URLs',URL,/387.xml scheme,schemes,scheme's,schemes',/327.xml interface,user-interface,/306.xml validation,validated,validates,validating,validate,/114.xml values,value's,values',value,/412.xml variable,variables,variable's,variables',variable,var,var's,var',vars,/461.xml vertexes,vertices,vertexes',vertices',vertex,vertex's,/143.xml VFW,VFW's,/224.xml video,video-capture,video-captures,/337.xml videoclip,videoclips,videoclip's,videoclips',/284.xml .wav,.wavs,.wav's,.wavs',wavs,wav's,wavs',WAV,/209.xml WDEF,WDEFs,WDEF's,WDEFs',/525.xml webservers,webserver's,webservers',webserver,/389.xml whitespace,whitespace's,/489.xml wildcards,wildcard's,wildcards',wildcard,glob,globbing,globs,globbed,/488.xml Windows,Windows's,/232.xml words,word's,words',word,/122.xml XBMs,XBM's,XBMs',.xbm,.XBMs,.XBM's,.XBMs',XBM,/304.xml XCMDs,XCMD's,XCMDs',XCMD,/539.xml XFCNs,XFCN's,XFCNs',XFCN,/414.xml XML,XML's,/288.xml tree,tree,trees,tree's,trees',/129.xml XPM,XPMs,XPM's,XPMs',.XPM,.XPMs,.XPM's,.XPMs',/147.xml xTalk,xTalks,xTalk's,xTalks',/396.xml XWDs,XWD's,XWDs',.xwd,.XWDs,.XWD's,.XWDs',XWD,/274.xml zooming,zoomed,zooms,zoom,/515.xml \ No newline at end of file diff --git a/Documentation/dictionary/datagrid.lcdoc b/Documentation/dictionary/datagrid.lcdoc new file mode 100644 index 0000000000..3d81fcf7cd --- /dev/null +++ b/Documentation/dictionary/datagrid.lcdoc @@ -0,0 +1,3611 @@ +Library: Datagrid + +Type: object + +Summary: An object for forms or tables + +Description: +The Data Grid enables you to integrate powerful tables and forms into +your LiveCode projects. Data grids combine LiveCode groups and behaviors +to provide you with a simple, yet flexible means of displaying your data +in just about any way you want. See [the datagrid lessson](http://lessons.livecode.com/m/datagrid/l/7301-what-is-the-data-grid) +for full documentation, lessons, and tutorials. + +Name: Datagrid General Properties + +Type: glossary + +Syntax: Datagrid General Properties + +Associations: datagrid + +Summary: General properties of the datagrid are applicable whether the +'style' property is set to 'form' or 'table' + +Description: +All general data grid properties are stored in the dgProps custom +property set. To access a property you can use dgProps or dgProp: + + put the dgProp[ "PROPERTY_NAME" ] of group "Data Grid" + + +Name: allow editing + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: set the dgProp["allow editing"] of group "Data Grid" + +Summary: Set to true to allow users to edit the cells of a table or the +fields in a form. + +Description: + +Set to true to allow users to edit the cells of a table or the fields in +a form. Note that when customizing templates for form rows or table +columns you would check this property to determine if fields should +allow editing. The default Row Behavior script contains an Example of + +how to do this. + + +Name: alternate row color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["alternate row color"] of group "Data Grid" + +Summary: The color of every other row's background. + +Description: + +The color of every other row's background. Default value is empty in +which case a default hilite color is used. Only applicable when +'alternate row colors' is true. Prefix property name with "effective" to +get the color being used. + + +Name: alternate row colors + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["alternate row colors"] of group "Data Grid" + +Summary: Set to true to alternate the background colors of every other +row. + +Description: + +Set to true to alternate the background colors of every other row. + + +Name: auto hilite + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["auto hilite"] of group "Data Grid" + +Summary: Enables the data grid to automatically handle row highlighting. + +Description: + +Set to true if you would like the data grid to automatically handle row +highlighting in response to user interaction. + + +Name: background color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["background color"] of group "Data Grid" + +Summary: The background color of the data grid. + +Description: + +The background color of the data grid. Note that if 'alternate row +colors' is true then the alternating row colors will cover the +background. + + +Name: cache controls + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["cache controls"] of group "Data Grid" + +Summary: Caches all controls for rendering. + +Description: + +By default the data grid only draws the controls that are visible on the +screen. In circumstances where you don't have large amounts of records +but the records you have take a long time to draw you may cache all of +the controls when the data grid is drawn. This takes a little longer to +display at the beginning but will offer smooth scrolling when the user +interacts with the data grid. + + +Name: column divider color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["column divider color"] of group "Data Grid" + +Summary: Sets the color of the table column dividers. + +Description: + +Sets the color of the table column dividers. Prefix property name with +"effective" to get the color being used when this property is set to +empty + + +Name: column margins + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["column margins"] of group "Data Grid" + +Summary: Specifies the margins to be applied to each cell in a column. + +Description: + +Specifies the margins to be applied to each cell in a column. + + +Name: control type + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["control type"] of group "Data Grid" + +Summary: Returns "data grid" + +Description: + +Returns "data grid". You can check this property to determine if a group +is a data grid. + + +Name: dim on focusOut + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["dim on focusOut"] of group "Data Grid" + +Summary: Dims the highlighted lines when the data grid does not have +focus. + +Description: + +If true then the highlighted lines will be dimmed to 'dimmed hilite +color' when the data grid does not have focus. Default is true. + + +Name: dimmed hilite color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["dimmed hilite color"] of group "Data Grid" + +Summary: Color that highlighted lines will be when control is not +focused. + +Description: + +Color that highlighted lines will be when control is not focused. Prefix +property name with "effective" to get the color being used when this +property is set to empty. + + +Name: fixed row height + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["fixed row height"] of group "Data Grid" + +Summary: Set to true if all of your data will be drawn at the same +height. + +Description: + +Set to true if all of your data will be drawn at the same height. +Setting this to true will dramatically improve performance the first +time the data grid is drawn as the data grid does not have to determine +the height of all of your records before drawing. Default value is true. + + +Name: hilite color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["hilite color"] of group "Data Grid" + +Summary: The color to use when highlighting a row. + +Description: + +The color to use when highlighting a row. If empty then the hiliteColor +property is used. Prefix property name with "effective" to get the color +being used when this property is set to empty. + + +Name: hilited text color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["hilited text color"] of group "Data Grid" + +Summary: The color to apply to text when a row is highlighted. + +Description: + +The color to apply to text when a row is highlighted. By default this +property is empty in which case the color is black if the average of the +RGB value for the hilite color > 128, white otherwise. + + +Name: multiple lines + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["multiple lines"] of group "Data Grid" + +Summary: Set to true to allow the user to select multiple lines in the +data grid. + +Description: + +Set to true to allow the user to select multiple lines in the data grid. + + +Name: opaque + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["opaque"] of group "Data Grid" + +Summary: Shows or hides the data grid background. + +Description: + +Shows or hides the data grid background. + + +Name: persistent data + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["persistent data"] of group "Data Grid" + +Summary: Set to true if you would like the data grid to store the data +being displayed between sessions. + +Description: + +Set to true if you would like the data grid to store the data being +displayed between sessions. The data grid always works with data stored +in a script local variable but if this value is true then the data will +be cached in a custom property as well. This will double the memory used +so this is suitable for small lists. For large data sets you should set +this property to 'false' and set the data grid data each time the data +grid is opened. The default value is 'true'. + + +Name: row color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["row color"] of group "Data Grid" + +Summary: The primary row color. + +Description: + +The primary row color. This color alternates with 'alternate row color'. +Prefix property name with "effective" to get the color being used when +this property is set to empty + + +Name: row height + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["row height"] of group "Data Grid" + +Summary: This represents the height that your rows will be drawn at. + +Description: + +For tables and forms whose 'fixed row height' property is true this +represents the height that your rows will be drawn at. If this property +is not set for a form whose 'fixed control height' is true then the +record template group height is used. For forms whose 'fixed control +height' is false this represents the height that alternating rows that +contain no data will be drawn at. + + +Name: row template + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["row template"] of group "Data Grid" + +Summary: This is the group that represents a record in your data grid. + +Description: + +This is the group that represents a record in your data grid. If the +style of the data grid is form then this group will be copied into the +data grid. If the data grid style is table then the data grid looks in +this group for controls named after the columns in your table. If the +data grid finds a control in this group that matches a column name then +the control will be used to visually represent the column. Otherwise a +field is used. By default the LiveCode IDE creates this group on a card +in a stack whose name starts with "Data Grid Template". Clicking the +"Row Template" button in the Property Inspector reveal the card +containing this group. + + +Name: scroll when hscrollbar is hidden + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["scroll when hscrollbar is hidden"] of group +"Data Grid" + +Summary: This overrides the default horizontal scrolling behavior. + +Description: + +By default a data grid will not respond to the mouse scroll wheel, page +up, page down, home or end if the scrollbar is hidden. Set this property +to true if you would like to override this behavior. This is useful if +you want to create custom scrollbars. + + +Name: scroll when vscrollbar is hidden + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["scroll when vscrollbar is hidden"] of group +"Data Grid" + +Summary: This overrides the default vertical scrolling behavior. + +Description: + +By default a data grid will not respond to the mouse scroll wheel, page +up, page down, home or end if the scrollbar is hidden. Set this property +to true if you would like to override this behavior. This is useful if +you want to create custom scrollbars. + + +Name: scrollbar corner offset + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["scrollbar corner offset"] of group "Data Grid" + +Summary: Scrollbar ofset from the corner when only one is visible. + +Description: + +This property is an integer that specifies the distance from the corner +of the window that the vertical and horizontal scrollbars position +themselves when only one of them is visible. This is primarily useful on +OS X when your data grid reaches all the way to the bottom right corner +of the window where the window drag handle appears. Setting this to a +value like "15" will keep your scrollbar controls from being hidden +behind the window drag handle. Default value is "0". + + +Name: show vscrollbar + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["show vscrollbar"] of group "Data Grid" + +Summary: Toggles the visibility of the vertical scrollbar. True, false, +or auto. + +Description: + +Toggles the visibility of the vertical scrollbar. True, false, or auto. + + +Name: show hscrollbar + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["show hscrollbar"] of group "Data Grid" + +Summary: Toggles the visibility of the horizontal scrollbar for a table. +True, false or auto. + +Description: + +Toggles the visibility of the horizontal scrollbar for a table. True, +false or auto. + + +Name: scrollbar width + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["scrollbar width"] of group "Data Grid" + +Summary: Set the width of the scrollbars + +Description: + +Set to an integer or to auto if you would like the data grid to set the +appropriate width based on the platform it is being displayed on. +Default is auto. When set to auto you can retrieve the actual width in +pixels using effective scrollbar width. + + +Name: style + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["style"] of group "Data Grid" + +Summary: Gets the style of the data grid, either 'form' or 'table'. + +Description: + +Gets the style of the data grid, either 'form' or 'table'. + + +Name: text color + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["text color"] of group "Data Grid" + +Summary: The text color to apply to the data area of a table or form. + +Description: + +The text color to apply to the data area of a table or form. Prefix +property name with "effective" to get the color being used when this +property is set to empty + + +Name: text font + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["text font"] of group "Data Grid" + +Summary: The font to apply to the data area of a table or form. + +Description: + +The font to apply to the data area of a table or form. Prefix property +name with "effective" to get the font being used when this property is +set to empty. + + +Name: text size + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["text size"] of group "Data Grid" + +Summary: The text size to apply to the data area of a table or form. + +Description: + +The text size to apply to the data area of a table or form. Prefix +property name with "effective" to get the size being used when this +property is set to empty. + + +Name: text style + +Type: property + +Associations: datagrid, datagrid general properties + +Syntax: put the dgProp["text style"] of group "Data Grid" + +Summary: The text style to apply to the data area of a table or form. + +Description: + +The text style to apply to the data area of a table or form. Prefix +property name with "effective" to get the style being used when this +property is set to empty. + + +Name: Datagrid Table Properties + +Type: glossary + +Associations: datagrid + +Syntax: Datagrid Table Properties + +Summary: Table properties of the datagrid are applicable when the 'style' +property is set to 'table'. + +Description: + +All data grid table properties are stored in the dgProps custom property +set. To access a property you can use dgProps or dgProp: + + put the dgProp[ "PROPERTY_NAME" ] of group "Data Grid" + + +Name: allow column resizing + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["allow column resizing"] of group "Data Grid" + +Summary: If true then the user can resize columns in the table header. + +Description: + +If true then the user can resize columns in the table header. Note that +you can also turn off resizing for individual columns which would +override this setting. + + +Name: column divider color + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["column divider color"] of group "Data Grid" + +Summary: The color of the column dividers in a table. + +Description: + +The color of the column dividers in a table. + + +Name: column alignments + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["column alignments"] of group "Data Grid" + +Summary: Allows you to set all column alignment values at once. + +Description: + +Allows you to set all column alignment values at once. Line delimited +list of alignment values. + + +Name: column visibility + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["column visibility"] of group "Data Grid" + +Summary: Allows you to set the visible property for all columns at once. + +Description: + +Allows you to set the visible property for all columns at once. Line +delimited list of boolean values. + + +Name: column widths + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["column widths"] of group "Data Grid" + +Summary: Allows you to set all column widths at once. Comma delimited +list of integers. + +Description: + +Allows you to set all column widths at once. Comma delimited list of +integers. + + +Name: columns + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["columns"] of group "Data Grid" + +Summary: Line delimited list of columns in your table. + +Description: + +Line delimited list of columns in your table. + + +Name: column labels + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["column labels"] of group "Data Grid" + +Summary: Line delimited list of labels for columns in your table. + +Description: + +Line delimited list of labels for columns in your table. + + +Name: corner color + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["corner color"] of group "Data Grid" + +Summary: The color of the corner piece that appears when both horizontal +and vertical scrollbars are visible. + +Description: + +The color of the corner piece that appears when both horizontal and +vertical scrollbars are visible. You set set to a solid color, a +gradient (two colors, one per line) or an array containing the keys of +the fillGradient property. + + +Name: default column behavior + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["default column behavior"] of group "Data Grid" + +Summary: Used to set the default column behavior. + +Description: + +The table style has an internal behavior that is used for columns which +have no custom control defined for them. This behavior sets the text of +a field as well as the alignment, etc. You can set this property to a +button containing the default behavior you would like. This can be +useful if you need to display html, unicode or rtf text among other +things. The default value is empty. To see the script that the data grid +uses by default for columns you can edit the script of button "Default +Column" of group "Behaviors" of stack "revDataGridLibrary" + + +Name: default header behavior + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["default header behavior"] of group "Data Grid" + +Summary: Used to set the default header behavior. + +Description: + +The table style has an internal behavior that is used for column +headers. If you would like to override the default behavior for column +headers you can set this property to point to a button with your own +behavior script. To see the script that the data grid uses by default +you can edit the script of button "Default Header" of group "Behaviors" +of stack "revDataGridLibrary" + + +Name: header background color + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header background color"] of group "Data Grid" + +Summary: The background color of the header. + +Description: + +The background color of the header. You set set to a solid color, a +gradient (two colors, one per line) or an array containing the keys of +the fillGradient property. + + +Name: header background hilite color + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header background hilite color"] of group "Data +Grid" + +Summary: The background color of the header that is being sorted by. + +Description: + +The background color of the header that is being sorted by. You set set +to a solid color, a gradient (two colors, one per line) or an array +containing the keys of the fillGradient property. + + +Name: header height + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header height"] of group "Data Grid" + +Summary: The height of the header are of the table. + +Description: + +The height of the header are of the table. + + +Name: header margins + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header margins"] of group "Data Grid" + +Summary: Specifies the margins to be applied to the fields that display +the header text. + +Description: + +Specifies the margins to be applied to the fields that display the +header text. + + +Name: header text color + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header text color"] of group "Data Grid" + +Summary: The text color to apply to the header area of a table. + +Description: + +The text color to apply to the header area of a table. Prefix property +name with "effective" to get the color being used when this property is +set to empty + + +Name: header text font + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header text font"] of group "Data Grid" + +Summary: The font to apply to the header area of a table. + +Description: + +The font to apply to the header area of a table. Prefix property name +with "effective" to get the font being used when this property is set to +empty + + +Name: header text size + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header text size"] of group "Data Grid" + +Summary: The text size to apply to the header area of a table. + +Description: + +The text size to apply to the header area of a table. Prefix property +name with "effective" to get the size being used when this property is +set to empty + + +Name: header text style + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["header text style"] of group "Data Grid" + +Summary: The text style to apply to the header area of a table. + +Description: + +The text style to apply to the header area of a table. Prefix property +name with "effective" to get the style being used when this property is +set to empty + + +Name: show column dividers + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["show column dividers"] of group "Data Grid" + +Summary: Toggles the visibility of the column dividers in the data +display area. + +Description: + +Toggles the visibility of the column dividers in the data display area. +Default value is true. + + +Name: show header + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["show header"] of group "Data Grid" + +Summary: Toggles the visibility of the header. Default value is true. + +Description: + +Toggles the visibility of the header. Default value is true. + + +Name: sort by column + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["sort by column"] of group "Data Grid" + +Summary: The column that the table data is currently being sorted by. + +Description: + +The column that the table data is currently being sorted by. You can set +this property to sort by a new column. + + +Name: visible columns + +Type: property + +Associations: datagrid, datagrid table properties + +Syntax: put the dgProp["visible columns"] of group "Data Grid" + +Summary: Line delimited list of columns in your table that are visible. + +Description: + +Line delimited list of columns in your table that are visible. + + +Name: Datagrid Column Properties + +Type: glossary + +Syntax: Datagrid Column Properties + +Associations: datagrid + +Summary: These properties allow you to set properties of individual +columns in a table when the 'style' property is set to 'table'. + +Description: + +These properties allow you to set properties of individual columns in a +table. The syntax you use resembles: set the dgColumnSortType ["COLUMN"] +of group "Data Grid" to "numeric" where "COLUMN" is the name of the +column you are targeting. + + +Name: dgColumnAlignment + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnAlignment["col1"] of group "Data Grid" + +Summary: Get/set the alignment for a column. + +Description: + +Get/set the alignment for a column. Valid values are 'left', 'right' or +'center'. + + +Name: dgColumnIsEditable + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnIsEditable["col1"] of group "Data Grid" + +Summary: Toggle whether or not a column is editable by the user. + +Description: + +Toggle whether or not a column is editable by the user. Set to +true/false. + + +Name: dgColumnIsVisible + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnIsVisible["col1"] of group "Data Grid" + +Summary: Get/set the visibility of the column. + +Description: + +Get/set the visibility of the column. + + +Name: dgColumnIsResizable + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnIsResizable["col1"] of group "Data Grid" + +Summary: Get/set whether or not a column is resizable. + +Description: + +Get/set whether or not a column is resizable. + + +Name: dgColumnLabel + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnLabel["col1"] of group "Data Grid" + +Summary: Get/set the label used for the column. + +Description: + +Get/set the label used for the column. If the label is empty then the +column name is used. + + +Name: dgColumnMaxWidth + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnMaxWidth["col1"] of group "Data Grid" + +Summary: Get/Set the maximum width that a column can be resized to. + +Description: + +Get/Set the maximum width that a column can be resized to. + + +Name: dgColumnMinWidth + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnMinWidth["col1"] of group "Data Grid" + +Summary: Get/Set the minimum width that a column can be resized to. + +Description: + +Get/Set the minimum width that a column can be resized to. + + +Name: dgColumnName + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: set the dgColumnName["col1"] of group "Data Grid" to pNewName + +Summary: Set a new name for a column. + +Description: + +Set a new name for a column. + + +Name: dgColumnTemplate + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnTemplate["col1"] of group "Data Grid" + +Summary: Get the control that is used to visually represent the column +in the table. + +Description: + +Get the control that is used to visually represent the column in the +table. This control will be a control in the 'row template' group with +the same name as the column. If no matching control exists then a field +is used. + + +Name: dgColumnTooltip + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnTooltip["col1"] of group "Data Grid" + +Summary: Set the tooltip that appears when the mouse is over the column +header. + +Description: + +Set the tooltip that appears when the mouse is over the column header. + + +Name: dgHeaderTemplate + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgHeaderTemplate["col1"] of group "Data Grid" + +Summary: Get the control that is used to visually represent the header +for a column. + +Description: + +Get the control that is used to visually represent the header for a +column. This control will be a control in the 'row template' group name +"COLUMN [Header]". If no matching control exists then the deafult header +control is used. + + +Name: dgColumnSortDirection + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnSortDirection["col1"] of group "Data Grid" + +Summary: Get/set the direction of the sort for the column. + +Description: + +Get/set the direction of the sort for the column. Valid values are +'ascending' or 'descending'. + + +Name: dgColumnSortIsCaseSensitive + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnSortIsCaseSensitive["col1"] of group "Data Grid" + +Summary: Get/set whether or not column sort is case sensitive. + +Description: + +Get/set whether or not column sort is case sensitive. Default value is +false. + + +Name: dgColumnSortType + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnSortType["col1"] of group "Data Grid" + +Summary: Get/set the sort type of the column. + +Description: + +Get/set the sort type of the column to 'text', 'numeric', 'datetime' or +'system datetime'. + + +Name: dgColumnWidth + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgColumnWidth["col1"] of group "Data Grid" + +Summary: Get/set the width of a column. + +Description: + +Get/set the width of a column. + + +Name: dgHeaderAlignment + +Type: property + +Associations: datagrid, datagrid column properties + +Syntax: put the dgHeaderAlignment["col1"] of group "Data Grid" + +Summary: Get/set the alignment for a column's header. + +Description: + +Get/set the alignment for a column's header. + + +Name: Template Field Editor Properties + +Type: glossary + +Syntax: Template Field Editor Properties + +Associations: datagrid + +Summary: Datagrid cells can be edited. These property configure that +editor. + +Description: + +The template field editor properties are set using the +dgTemplateFieldEditor custom property. + + set the dgTemplateFieldEditor["PROPERTY_NAME"] \ + of group "Data Grid" to SOME_VALUE + + +Name: select text + +Type: property + +Associations: datagrid, template field editor properties + +Syntax: set the dgTemplateFieldEditor["select text"] of group "Data +Grid" to true + +Summary: Set to true to select all text in the field editor. + +Description: + +Set to true to select all text in the field editor. + + +Name: text + +Type: property + +Associations: datagrid, template field editor properties + +Syntax: set the dgTemplateFieldEditor["text"] of group "Data Grid" to +pText + +Summary: Set to a string that will be assigned to the text property of +the field editor. + +Description: + +Set to a string that will be assigned to the text property of the field +editor. + + +Name: htmltext + +Type: property + +Associations: datagrid, template field editor properties + +Syntax: set the dgTemplateFieldEditor["htmltext"] of group "Data Grid" +to "

Hello World

" + +Summary: Set to a string that will be assigned to the htmltext property +of the field editor. + +Description: + +Set to a string that will be assigned to the htmltext property of the +field editor. + + +Name: rtftext + +Type: property + +Associations: datagrid, template field editor properties + +Syntax: put the dgTemplateFieldEditor["rtftext"] of group "Data Grid" + +Summary: Set to a string that will be assigned to the rtftext property +of the field editor. + +Description: + +Set to a string that will be assigned to the rtftext property of the +field editor. + + +Name: unicodetext + +Type: property + +Associations: datagrid, template field editor properties + +Syntax: put the dgTemplateFieldEditor["unicodetext"] of group "Data +Grid" + +Summary: Set to a string that will be assigned to the unicodetext +property of the field editor. + +Description: + +Set to a string that will be assigned to the unicodetext property of the +field editor. + + +Name: utf8text + +Type: property + +Associations: datagrid, template field editor properties + +Syntax: put the dgTemplateFieldEditor["utf8text"] of group "Data Grid" + +Summary: Set to a string that will be assigned to the unicodetext +property of the field editor after being converted from UTF-8 to UTF16. + +Description: + +Set to a string that will be assigned to the unicodetext property of the +field editor after being converted from UTF-8 to UTF16. + + +Name: dgHeader + +Type: property + +Associations: datagrid + +Syntax: put the dgHeader of group "Data Grid" + +Summary: Returns the long id of the group that contains the controls for +the table header. + +Description: + +Returns the long id of the group that contains the controls for the +table header. Use this property in a mouseDown/mouseUp handler to +determine if the user clicked on a the table header. If the dgHeader of +the target is not empty then ... (user clicked in table header). + + +Name: dgHeaderControl + +Type: property + +Associations: datagrid + +Syntax: put the dgHeaderControl of group "Data Grid" + +Summary: Returns the long id of the group that contains the controls for +a column header. + +Description: + +Returns the long id of the group that contains the controls for a column +header. Use this property in a mouseDown/mouseUp handler to determine if +the user clicked on a column header. If the dgHeaderControl of the +target is not empty then... (user clicked in a column header). + + +Name: dgControl + +Type: property + +Associations: datagrid + +Syntax: get the dgControl of the target + +Summary: Returns the long id of the data grid. + +Description: + +Returns the long id of the data grid. Useful in row/column template +behaviors when you need to get properties of the data grid. + + +Name: dgData + +Type: property + +Associations: datagrid + +syntax: set the dgData of group "DataGrid" to + +Summary: Get or set the data array that the data grid will display. + +Example: + +get the dgData of grp "Data Grid" + +Description: +Get or set the data array that the data grid will display. The first +dimension of the array uses numeric keys and the value of each is an +array. You can store anything you would like in each numeric key's +array. For data grid tables the keys should match the column names in +order for the data grid to correctly map the array value to the column +cell. The following array would represent two records in the data grid: + + put "Hi" into theA[1]["message"] + put "Bye" into theA[2]["message"] + set the dgData of group "DataGrid" to theA + +Name: dgDataControlOfIndex + +Type: property + +Associations: datagrid + +Syntax: get the dgDataControlOfIndex[pIndex] of group "DataGrid" + +Summary: Returns the long id of the data control associated with an +index. + + +Description: +Returns the long id of the data control associated with an index. +If "cache controls" is not turned on then this property returns empty +if the index has no control associated with it because it is offscreen. + +>*Important:* The property is available only for +Datagrids whose