Welcome to TiddlyWiki created by Jeremy Ruston; Copyright © 2004-2007 Jeremy Ruston, Copyright © 2007-2011 UnaMesa Association
~OpenOffice/~LibreOffice Base with ~Access2Base
//{{{
REM Open a form ...
OpenForm("myForm")
REM Move a form to new left-top coordinates ...
Dim ofForm As Object ' In VBA => Dim ofForm As Form
Set ofForm = Forms("myForm")
ofForm.Move(100, 200)
REM Get the value of a control ...
Dim ocControl As Object
ocControl = ofForm.Controls("myControl")
MsgBox ocControl.Value
REM Hide a control ...
ocControl.Visible = False
REM ... or alternatively ...
setValue("Forms!myForm!myControl.Visible", False) ' Shortcut notation
' In VBA => Forms!myForm!myControl.Visible = False
//}}}
Type the text for 'Actions'
(Q) Can I add a "All" option in a combo box on top of the list ?
(R) Use either a special SELECT statement or, alternatively, the [[RowSource]] property to adjust the list.
Assuming next table:
<<tiddler "CustomersTable">>
we want to make a combo box listing all //~CompanyName//s.
!!!Solution with a UNION SELECT statement:
Define your combo box with the //List content// defined like
//{{{
SELECT "CompanyName" FROM "Customers" UNION SELECT '(All)' as "Bogus" From "Customers" ORDER BY "CompanyName"
//}}}
Depending on the database (RDBMS) used above SQL will probably require that the //Type of list contents// entry contains {{{Sql [Native]}}}
!!!Solution with a bit code
This solution requires that the list of proposed values remains unchanged as long as the form remains open.
Additionally it is valid ONLY for LISTBOXES.
The listbox is defined, exactly as above. Store in the //List content// entry a more usual SQL statement:
//{{{
SELECT DISTINCT "CompanyName" FROM "Customers"
//}}}
Note that the code below is also usable if the //~ListBox// is based on a list of values i.o. data in a database table.
The code, triggered from the form's //When loading// event, will concatenate "(All)" with all values contained in the list.
//{{{
Sub AddAllToList(poEvent As Object)
Dim oEvent As Object, ofForm As Object, ocList As Object
Dim i As Integer, sSource As String
Set oEvent = Events(poEvent)
Set ofForm = oEvent.Source
Set ocList = ofForm.Controls("listBox-All")
With ocList
Select Case .RowSourceType
Case com.sun.star.form.ListSourceType.VALUELIST
.RowSource = "(All);" & .RowSource
Case Else ' Table, Query, SQL, SqlPassThrough
sSource = "(All)"
For i = 0 To .ListCount - 1
sSource = sSource & ";" & .Itemdata(i)
Next i
.RowSourceType = com.sun.star.form.ListSourceType.VALUELIST
.RowSource = sSource
End Select
End With
End Sub
//}}}
!!!See also
[[ComboBox]]
[[ListBox]]
[[RowSource]]
[[RowSourceType]]
The //~AddItem// method adds a new item to the list of values displayed by the specified list box control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ListBox]] | [[ListBox]] |A listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.AddItem(}}}//value// [, //index//]{{{)}}}
| !Argument | !Type | !Description |
| value | String |The display text for the new item. |
| index | Integer<br />Long |The position of the item in the list.<br />If this argument is omitted, the item is added to the end of the list. |
!!!Remarks
*The [[RowSourceType]] property must contain the value {{{com.sun.star.form.ListSourceType.VALUELIST}}}.
*Combo boxes do not support this value for that property. That's why //~AddItem// is applicable only on listboxes.
*List item numbers start from zero. If the value of the {{{index}}} argument doesn't correspond to an existing item number or to the last item number + 1, an error occurs.
*//~AddItem// returns True if success, False otherwise.
!!!Error messages
|Argument nr.X is invalid |
|Method not applicable in this context |
!!!See also
[[ListBox]]
[[RemoveItem]]
[[RowSource]]
[[RowSourceType]]
!!!Example
<<tiddler "Addremoveitem example">>
Display in an empty ListBox all dates between today and today + 9 days
//{{{
Dim ocList As Object, i As Integer, sDate As String
Set ocList = getObject("Forms!myForm!myListBoxDate")
sDate = Date
For i = 0 To 9
ocList.AddItem(sDate)
sDate = DateAdd("d", 1, sDate)
Next i
//}}}
Remove from the added dates all the non-working days (it is assumed that, for any reason, this could not have been done while loading the dates in the box ...)
//{{{
Dim ocList As Object, i As Integer, sDates() As String, dDate As Date
Set ocList = getObject("Forms!myForm!myListBoxDate")
sDates() = ocList.ItemData
For i = 0 To UBound(sDates)
dDate = DateValue(sDates(i))
If DatePart("w", dDate, 2) > 5 Then ocList.RemoveItem(sDates(i)) ' Remove saturdays and sundays
Next i
//}}}
The //~AllForms// collection describes instances of all __forms__ present in the database document (".odb" file).
!!!Syntax
{{{AllForms()}}} or {{{AllForms}}}
{{{AllForms(index)}}}
{{{AllForms(formname)}}}
| !Argument #1 | !Type |!Returned value |
|| absent |A [[Collection]] object |
| index | integer<br>long |A [[Form]] object corresponding to the index-th item in the ~AllForms() collection. The 1st form is ~AllForms(0), the 2nd is ~AllForms(1) and so on ... The last one is ~AllForms.Count - 1.|
| formname | string |A [[Form]] object having the argument as name. The argument is NOT case-sensitive.|
!!!Remarks
*~Access2Base does not support a hierarchy of form names although Base does it. Only single form names are allowed.
*The //formname// argument is not case sensitive.
*When invoked from a [[standalone form|Standalone Forms]], the {{{index}}} argument must be 0. Alternatively the {{{formname}}} argument must be the own name of the form, __which is often "~MainForm"__.
!!!Error messages
|Argument nr.1 is invalid |
|Out of array range or incorrect array size for collection ~AllForms() |
|Form "..." not found |
!!!See also ...
[[Forms]]
!!!Examples
<<tiddler "AllForms examples">>
To display the name of all forms (uses the [[Name]] property):
//{{{
Dim i As Integer, oCollection As Object
Set oCollection = AllForms
For i = 0 To oCollection.Count - 1 'AllForms without argument returns a Collection object
Print AllForms(i).Name, 'AllForms(...) with an argument returns a Form object
Next i
Print
//}}}
Can shorter ... :
//{{{
Dim i As Integer
For i = 0 To AllForms.Count - 1 'AllForms without argument returns a Collection object
Print AllForms(i).Name, 'AllForms(...) with an argument returns a Form object
Next i
Print
//}}}
To know the exact name of a form:
//{{{
Dim ofForm As Object
Set ofForm = AllForms("MYFORM") 'Exact name = myForm :o)
MsgBox ofForm.Name
//}}}
Make a form read-only
//{{{
Dim ofForm As Object
Set ofForm = AllForms("myForm")
With ofForm
.AllowEdits = False
.AllowDeletions = False
.AllowAdditions = False
End With
//}}}
The //~AllowAdditions// property specifies whether a user can add a record when using a form.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
|[[SubForm]] |A subform in an open form |
!!!Syntax
//form//{{{.AllowAdditions}}}
//form//{{{.AllowAdditions}}} = //value//
//subform//{{{.AllowAdditions}}}
//form//{{{.AllowAdditions}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property '~AllowAdditions' |
!!!See also
[[AllowDeletions]]
[[AllowEdits]]
!!!Example
<<tiddler "Allow example">>
The //~AllowDeletions// property specifies whether a user can delete a record when using a form.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
|[[SubForm]] |A subform in an open form |
!!!Syntax
//form//{{{.AllowDeletions}}}
//form//{{{.AllowDeletions}}} = //value//
//subform//{{{.AllowDeletions}}}
//subform//{{{.AllowDeletions}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property '~AllowDeletions' |
!!!See also
[[AllowAdditions]]
[[AllowEdits]]
!!!Example
<<tiddler "Allow example">>
The //~AllowEdits// property specifies whether a user can edit saved records when using a form.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
|[[SubForm]] |A subform in an open form |
!!!Syntax
//form//{{{.AllowEdits}}}
//form//{{{.AllowEdits}}} = //value//
//subform//{{{.AllowEdits}}}
//form//{{{.AllowEdits}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property '~AllowEdits' |
!!!See also
[[AllowAdditions]]
[[AllowDeletions]]
!!!Example
<<tiddler "Allow example">>
(Q) How can I control when a record is saved in a form ?
(R) Use the form's //Before record change// event to run code each time Base tries to save a record. This way, if the user doesn't want to save a record, you can issue an Undo command instead of saving the record.
For strange reasons the //Before record change// form event is fired twice while in most cases one occurrence would be sufficient. That's where the //Recommendation// property becomes useful.
Read [[Roberto Benitez's Forms and Dialogs document|http://www.baseprogramming.com/FormsAndDialogs.pdf]] about this strange behaviour (p. 20+).
!!!Solution
Next code will make it. The event fires here a //Function// which will return {{{True}}} only if the modification is confirmed by the user. Otherwise the //Undo// command is run automatically. Other requests for changes (INSERT or DELETE actions) will be accepted blindly.
//{{{
Function AskBeforeSave(poEvent As Object) As Boolean
Dim sMsg As String, oEvent As Object
REM MsgBox constants
Const vbYesNo = 4 ' Yes and No buttons
Const vbQuestion = 32 ' Warning query
Const vbYes = 6 ' Yes button pressed
AskBeforeSave = True
Set oEvent = Events(poEvent)
If oEvent.Recommendation = "IGNORE" Then Exit Function
If oEven.RowChangeAction <> com.sun.star.sdb.RowChangeAction.UPDATE Then Exit Function ' INSERT / DELETE ignored
sMsg = "Data has changed." & Chr(13) & "Do you wish to save the changes?" _
& Chr(13) & "Click Yes to save or No to discard changes."
If MsgBox(sMsg, vbQuestion + vbYesNo, "Save record ?") <> vbYes Then
RunCommand("RecUndo") ' Cancel editing done
AskBeforeSave = False
End If
End Function
//}}}
!!!See also
[[Event]]
[[Events Handler]]
[[RunCommand]]
text/plain
.txt .text .js .vbs .asp .cgi .pl
----
text/html
.htm .html .hta .htx .mht
----
text/comma-separated-values
.csv
----
text/javascript
.js
----
text/css
.css
----
text/xml
.xml .xsl .xslt
----
image/gif
.gif
----
image/jpeg
.jpg .jpe .jpeg
----
image/png
.png
----
image/bmp
.bmp
----
image/tiff
.tif .tiff
----
audio/basic
.au .snd
----
audio/wav
.wav
----
audio/x-pn-realaudio
.ra .rm .ram
----
audio/x-midi
.mid .midi
----
audio/mp3
.mp3
----
audio/m3u
.m3u
----
video/x-ms-asf
.asf
----
video/avi
.avi
----
video/mpeg
.mpg .mpeg
----
video/quicktime
.qt .mov .qtvr
----
application/pdf
.pdf
----
application/rtf
.rtf
----
application/postscript
.ai .eps .ps
----
application/wordperfect
.wpd
----
application/mswrite
.wri
----
application/msexcel
.xls .xls3 .xls4 .xls5 .xlw
----
application/msword
.doc
----
application/mspowerpoint
.ppt .pps
----
application/x-director
.swa
----
application/x-shockwave-flash
.swf
----
application/x-zip-compressed
.zip
----
application/x-gzip
.gz
----
application/x-rar-compressed
.rar
----
application/octet-stream
.com .exe .dll .ocx
----
application/java-archive
.jar
/***
|Name|AttachFilePlugin|
|Source|http://www.TiddlyTools.com/#AttachFilePlugin|
|Documentation|http://www.TiddlyTools.com/#AttachFilePluginInfo|
|Version|4.0.1|
|Author|Eric Shulman|
|License|http://www.TiddlyTools.com/#LegalStatements|
|~CoreVersion|2.1|
|Type|plugin|
|Requires|AttachFilePluginFormatters, AttachFileMIMETypes|
|Description|Store binary files as base64-encoded tiddlers with fallback links for separate local and/or remote file storage|
Store or link binary files (such as jpg, gif, pdf or even mp3) within your TiddlyWiki document and then use them as images or links from within your tiddler content.
> Important note: As of version 3.6.0, in order to //render// images and other binary attachments created with this plugin, you must also install [[AttachFilePluginFormatters]], which extends the behavior of the TiddlyWiki core formatters for embedded images ({{{[img[tooltip|image]]}}}), linked embedded images ({{{[img[tooltip|image][link]]}}}), and external/"pretty" links ({{{[[label|link]]}}}), so that these formatter will process references to attachment tiddlers as if a normal file reference had been provided. |
!!!!!Documentation
>see [[AttachFilePluginInfo]]
!!!!!Inline interface (live)
>see [[AttachFile]] (shadow tiddler)
><<tiddler AttachFile>>
!!!!!Revisions
<<<
2011.02.14 4.0.1 fix OSX error: use picker.file.path
2009.06.04 4.0.0 changed attachment storage format to use //sections// instead of embedded substring markers.
|please see [[AttachFilePluginInfo]] for additional revision details|
2005.07.20 1.0.0 Initial Release
<<<
!!!!!Code
***/
// // version
//{{{
version.extensions.AttachFilePlugin= {major: 4, minor: 0, revision: 1, date: new Date(2011,2,14)};
// shadow tiddler
config.shadowTiddlers.AttachFile="<<attach inline>>";
// add 'attach' backstage task (insert before built-in 'importTask')
if (config.tasks) { // for TW2.2b or above
config.tasks.attachTask = {
text: "attach",
tooltip: "Attach a binary file as a tiddler",
content: "<<attach inline>>"
}
config.backstageTasks.splice(config.backstageTasks.indexOf("importTask"),0,"attachTask");
}
config.macros.attach = {
// // lingo
//{{{
label: "attach file",
tooltip: "Attach a file to this document",
linkTooltip: "Attachment: ",
typeList: "AttachFileMIMETypes",
titlePrompt: " enter tiddler title...",
MIMEPrompt: "<option value=''>select MIME type...</option><option value='editlist'>[edit list...]</option>",
localPrompt: " enter local path/filename...",
URLPrompt: " enter remote URL...",
tiddlerErr: "Please enter a tiddler title",
sourceErr: "Please enter a source path/filename",
storageErr: "Please select a storage method: embedded, local or remote",
MIMEErr: "Unrecognized file format. Please select a MIME type",
localErr: "Please enter a local path/filename",
URLErr: "Please enter a remote URL",
fileErr: "Invalid path/file or file not found",
tiddlerFormat: '!usage\n{{{%0}}}\n%0\n!notes\n%1\n!type\n%2\n!file\n%3\n!url\n%4\n!data\n%5\n',
//}}}
// // macro definition
//{{{
handler:
function(place,macroName,params) {
if (params && !params[0])
{ createTiddlyButton(place,this.label,this.tooltip,this.toggleAttachPanel); return; }
var id=params.shift();
this.createAttachPanel(place,id+"_attachPanel",params);
document.getElementById(id+"_attachPanel").style.position="static";
document.getElementById(id+"_attachPanel").style.display="block";
},
//}}}
//{{{
createAttachPanel:
function(place,panel_id,params) {
if (!panel_id || !panel_id.length) var panel_id="_attachPanel";
// remove existing panel (if any)
var panel=document.getElementById(panel_id); if (panel) panel.parentNode.removeChild(panel);
// set styles for this panel
setStylesheet(this.css,"attachPanel");
// create new panel
var title=""; if (params && params[0]) title=params.shift();
var types=this.MIMEPrompt+this.formatListOptions(store.getTiddlerText(this.typeList)); // get MIME types
panel=createTiddlyElement(place,"span",panel_id,"attachPanel",null);
var html=this.html.replace(/%id%/g,panel_id);
html=html.replace(/%title%/g,title);
html=html.replace(/%disabled%/g,title.length?"disabled":"");
html=html.replace(/%IEdisabled%/g,config.browser.isIE?"disabled":"");
html=html.replace(/%types%/g,types);
panel.innerHTML=html;
if (config.browser.isGecko) { // FF3 FIXUP
document.getElementById("attachSource").style.display="none";
document.getElementById("attachFixPanel").style.display="block";
}
return panel;
},
//}}}
//{{{
toggleAttachPanel:
function (e) {
if (!e) var e = window.event;
var parent=resolveTarget(e).parentNode;
var panel = document.getElementById("_attachPanel");
if (panel==undefined || panel.parentNode!=parent)
panel=config.macros.attach.createAttachPanel(parent,"_attachPanel");
var isOpen = panel.style.display=="block";
if(config.options.chkAnimate)
anim.startAnimating(new Slider(panel,!isOpen,e.shiftKey || e.altKey,"none"));
else
panel.style.display = isOpen ? "none" : "block" ;
e.cancelBubble = true;
if (e.stopPropagation) e.stopPropagation();
return(false);
},
//}}}
//{{{
formatListOptions:
function(text) {
if (!text || !text.trim().length) return "";
// get MIME list content from text
var parts=text.split("\n----\n");
var out="";
for (var p=0; p<parts.length; p++) {
var lines=parts[p].split("\n");
var label=lines.shift(); // 1st line=display text
var value=lines.shift(); // 2nd line=item value
out +='<option value="%1">%0</option>'.format([label,value]);
}
return out;
},
//}}}
// // interface definition
//{{{
css:
".attachPanel { display: none; position:absolute; z-index:10; width:35em; right:105%; top:0em;\
background-color: #eee; color:#000; font-size: 8pt; line-height:110%;\
border:1px solid black; border-bottom-width: 3px; border-right-width: 3px;\
padding: 0.5em; margin:0em; -moz-border-radius:1em;-webkit-border-radius:1em; text-align:left }\
.attachPanel form { display:inline;border:0;padding:0;margin:0; }\
.attachPanel select { width:99%;margin:0px;font-size:8pt;line-height:110%;}\
.attachPanel input { width:98%;padding:0px;margin:0px;font-size:8pt;line-height:110%}\
.attachPanel textarea { width:98%;margin:0px;height:2em;font-size:8pt;line-height:110%}\
.attachPanel table { width:100%;border:0;margin:0;padding:0;color:inherit; }\
.attachPanel tbody, .attachPanel tr, .attachPanel td { border:0;margin:0;padding:0;color:#000; }\
.attachPanel .box { border:1px solid black; padding:.3em; margin:.3em 0px; background:#f8f8f8; \
-moz-border-radius:5px;-webkit-border-radius:5px; }\
.attachPanel .chk { width:auto;border:0; }\
.attachPanel .btn { width:auto; }\
.attachPanel .btn2 { width:49%; }\
",
//}}}
//{{{
html:
'<form>\
attach from source file\
<input type="file" id="attachSource" name="source" size="56"\
onChange="config.macros.attach.onChangeSource(this)">\
<div id="attachFixPanel" style="display:none"><!-- FF3 FIXUP -->\
<input type="text" id="attachFixSource" style="width:90%"\
title="Enter a path/file to attach"\
onChange="config.macros.attach.onChangeSource(this);">\
<input type="button" style="width:7%" value="..."\
title="Enter a path/file to attach"\
onClick="config.macros.attach.askForFilename(document.getElementById(\'attachFixSource\'));">\
</div><!--end FF3 FIXUP-->\
<div class="box">\
<table style="border:0"><tr style="border:0"><td style="border:0;text-align:right;width:1%;white-space:nowrap">\
embed data <input type=checkbox class=chk name="useData" %IEdisabled% \
onclick="if (!this.form.MIMEType.value.length)\
this.form.MIMEType.selectedIndex=this.checked?1:0; "> \
</td><td style="border:0">\
<select size=1 name="MIMEType" \
onchange="this.title=this.value; if (this.value==\'editlist\')\
{ this.selectedIndex=this.form.useData.checked?1:0; story.displayTiddler(null,config.macros.attach.typeList,2); return; }">\
<option value=""></option>\
%types%\
</select>\
</td></tr><tr style="border:0"><td style="border:0;text-align:right;width:1%;white-space:nowrap">\
local link <input type=checkbox class=chk name="useLocal"\
onclick="this.form.local.value=this.form.local.defaultValue=this.checked?config.macros.attach.localPrompt:\'\';"> \
</td><td style="border:0">\
<input type=text name="local" size=15 autocomplete=off value=""\
onchange="this.form.useLocal.checked=this.value.length" \
onkeyup="this.form.useLocal.checked=this.value.length" \
onfocus="if (!this.value.length) this.value=config.macros.attach.localPrompt; this.select()">\
</td></tr><tr style="border:0"><td style="border:0;text-align:right;width:1%;white-space:nowrap">\
remote link <input type=checkbox class=chk name="useURL"\
onclick="this.form.URL.value=this.form.URL.defaultValue=this.checked?config.macros.attach.URLPrompt:\'\';\"> \
</td><td style="border:0">\
<input type=text name="URL" size=15 autocomplete=off value=""\
onfocus="if (!this.value.length) this.value=config.macros.attach.URLPrompt; this.select()"\
onchange="this.form.useURL.checked=this.value.length;"\
onkeyup="this.form.useURL.checked=this.value.length;">\
</td></tr></table>\
</div>\
<table style="border:0"><tr style="border:0"><td style="border:0;text-align:right;vertical-align:top;width:1%;white-space:nowrap">\
notes \
</td><td style="border:0" colspan=2>\
<textarea name="notes" style="width:98%;height:3.5em;margin-bottom:2px"></textarea>\
</td><tr style="border:0"><td style="border:0;text-align:right;width:1%;white-space:nowrap">\
attach as \
</td><td style="border:0" colspan=2>\
<input type=text name="tiddlertitle" size=15 autocomplete=off value="%title%"\
onkeyup="if (!this.value.length) { this.value=config.macros.attach.titlePrompt; this.select(); }"\
onfocus="if (!this.value.length) this.value=config.macros.attach.titlePrompt; this.select()" %disabled%>\
</td></tr></tr><tr style="border:0"><td style="border:0;text-align:right;width:1%;white-space:nowrap">\
add tags \
</td><td style="border:0">\
<input type=text name="tags" size=15 autocomplete=off value="" onfocus="this.select()">\
</td><td style="width:40%;text-align:right;border:0">\
<input type=button class=btn2 value="attach"\
onclick="config.macros.attach.onClickAttach(this)"><!--\
--><input type=button class=btn2 value="close"\
onclick="var panel=document.getElementById(\'%id%\'); if (panel) panel.parentNode.removeChild(panel);">\
</td></tr></table>\
</form>',
//}}}
// // control processing
//{{{
onChangeSource:
function(here) {
var form=here.form;
var list=form.MIMEType;
var theFilename = here.value;
var theExtension = theFilename.substr(theFilename.lastIndexOf('.')).toLowerCase();
// if theFilename is in current document folder, remove path prefix and use relative reference
var h=document.location.href; folder=getLocalPath(decodeURIComponent(h.substr(0,h.lastIndexOf("/")+1)));
if (theFilename.substr(0,folder.length)==folder) theFilename='./'+theFilename.substr(folder.length);
else theFilename='file:///'+theFilename; // otherwise, use absolute reference
theFilename=theFilename.replace(/\\/g,"/"); // fixup: change \ to /
form.useLocal.checked = true;
form.local.value = theFilename;
form.useData.checked = !form.useData.disabled;
list.selectedIndex=1;
for (var i=0; i<list.options.length; i++) // find matching MIME type
if (list.options[i].value.indexOf(theExtension)!=-1) { list.selectedIndex = i; break; }
if (!form.tiddlertitle.disabled)
form.tiddlertitle.value=theFilename.substr(theFilename.lastIndexOf('/')+1); // get tiddlername from filename
},
//}}}
//{{{
onClickAttach:
function (here) {
clearMessage();
// get input values
var form=here.form;
var src=form.source; if (config.browser.isGecko) src=document.getElementById("attachFixSource");
src=src.value!=src.defaultValue?src.value:"";
var when=(new Date()).formatString(config.macros.timeline.dateFormat);
var title=form.tiddlertitle.value;
var local = form.local.value!=form.local.defaultValue?form.local.value:"";
var url = form.URL.value!=form.URL.defaultValue?form.URL.value:"";
var notes = form.notes.value;
var tags = "attachment excludeMissing "+form.tags.value;
var useData=form.useData.checked;
var useLocal=form.useLocal.checked;
var useURL=form.useURL.checked;
var mimetype = form.MIMEType.value.length?form.MIMEType.options[form.MIMEType.selectedIndex].text:"";
// validate checkboxes and get filename
if (useData) {
if (src.length) { if (!theLocation) var theLocation=src; }
else { alert(this.sourceErr); src.focus(); return false; }
}
if (useLocal) {
if (local.length) { if (!theLocation) var theLocation = local; }
else { alert(this.localErr); form.local.focus(); return false; }
}
if (useURL) {
if (url.length) { if (!theLocation) var theLocation = url; }
else { alert(this.URLErr); form.URL.focus(); return false; }
}
if (!(useData||useLocal||useURL))
{ form.useData.focus(); alert(this.storageErr); return false; }
if (!theLocation)
{ src.focus(); alert(this.sourceErr); return false; }
if (!title || !title.trim().length || title==this.titlePrompt)
{ form.tiddlertitle.focus(); alert(this.tiddlerErr); return false; }
// if not already selected, determine MIME type based on filename extension (if any)
if (useData && !mimetype.length && theLocation.lastIndexOf('.')!=-1) {
var theExt = theLocation.substr(theLocation.lastIndexOf('.')).toLowerCase();
var theList=form.MIMEType;
for (var i=0; i<theList.options.length; i++)
if (theList.options[i].value.indexOf(theExt)!=-1)
{ var mimetype=theList.options[i].text; theList.selectedIndex=i; break; }
}
// attach the file
return this.createAttachmentTiddler(src, when, notes, tags, title,
useData, useLocal, useURL, local, url, mimetype);
},
getMIMEType:
function(src,def) {
var ext = src.substr(src.lastIndexOf('.')).toLowerCase();
var list=store.getTiddlerText(this.typeList);
if (!list || !list.trim().length) return def;
// get MIME list content from tiddler
var parts=list.split("\n----\n");
for (var p=0; p<parts.length; p++) {
var lines=parts[p].split("\n");
var mime=lines.shift(); // 1st line=MIME type
var match=lines.shift(); // 2nd line=matching extensions
if (match.indexOf(ext)!=-1) return mime;
}
return def;
},
createAttachmentTiddler:
function (src, when, notes, tags, title, useData, useLocal, useURL, local, url, mimetype, noshow) {
if (useData) { // encode the data
if (!mimetype.length) {
alert(this.MIMEErr);
form.MIMEType.selectedIndex=1; form.MIMEType.focus();
return false;
}
var d = this.readFile(src); if (!d) { return false; }
displayMessage('encoding '+src);
var encoded = this.encodeBase64(d);
displayMessage('file size='+d.length+' bytes, encoded size='+encoded.length+' bytes');
}
var usage=(mimetype.substr(0,5)=="image"?'[img[%0]]':'[[%0|%0]]').format([title]);
var theText=this.tiddlerFormat.format([
usage, notes.length?notes:'//none//', mimetype,
useLocal?local.replace(/\\/g,'/'):'', useURL?url:'',
useData?('data:'+mimetype+';base64,'+encoded):'' ]);
store.saveTiddler(title,title,theText,config.options.txtUserName,new Date(),tags);
var panel=document.getElementById("attachPanel"); if (panel) panel.style.display="none";
if (!noshow) { story.displayTiddler(null,title); story.refreshTiddler(title,null,true); }
displayMessage('attached "'+title+'"');
return true;
},
//}}}
// // base64 conversion
//{{{
encodeBase64:
function (d) {
if (!d) return null;
// encode as base64
var keyStr = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
var out="";
var chr1,chr2,chr3="";
var enc1,enc2,enc3,enc4="";
for (var count=0,i=0; i<d.length; ) {
chr1=d.charCodeAt(i++);
chr2=d.charCodeAt(i++);
chr3=d.charCodeAt(i++);
enc1=chr1 >> 2;
enc2=((chr1 & 3) << 4) | (chr2 >> 4);
enc3=((chr2 & 15) << 2) | (chr3 >> 6);
enc4=chr3 & 63;
if (isNaN(chr2)) enc3=enc4=64;
else if (isNaN(chr3)) enc4=64;
out+=keyStr.charAt(enc1)+keyStr.charAt(enc2)+keyStr.charAt(enc3)+keyStr.charAt(enc4);
chr1=chr2=chr3=enc1=enc2=enc3=enc4="";
}
return out;
},
decodeBase64: function(input) {
var out="";
var chr1,chr2,chr3;
var enc1,enc2,enc3,enc4;
var i = 0;
// remove all characters that are not A-Z, a-z, 0-9, +, /, or =
input=input.replace(/[^A-Za-z0-9\+\/\=]/g, "");
do {
enc1=keyStr.indexOf(input.charAt(i++));
enc2=keyStr.indexOf(input.charAt(i++));
enc3=keyStr.indexOf(input.charAt(i++));
enc4=keyStr.indexOf(input.charAt(i++));
chr1=(enc1 << 2) | (enc2 >> 4);
chr2=((enc2 & 15) << 4) | (enc3 >> 2);
chr3=((enc3 & 3) << 6) | enc4;
out=out+String.fromCharCode(chr1);
if (enc3!=64) out=out+String.fromCharCode(chr2);
if (enc4!=64) out=out+String.fromCharCode(chr3);
} while (i<input.length);
return out;
},
//}}}
// // I/O functions
//{{{
readFile: // read local BINARY file data
function(filePath) {
if(!window.Components) { return null; }
try { netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); }
catch(e) { alert("access denied: "+filePath); return null; }
var file = Components.classes["@mozilla.org/file/local;1"].createInstance(Components.interfaces.nsILocalFile);
try { file.initWithPath(filePath); } catch(e) { alert("cannot read file - invalid path: "+filePath); return null; }
if (!file.exists()) { alert("cannot read file - not found: "+filePath); return null; }
var inputStream = Components.classes["@mozilla.org/network/file-input-stream;1"].createInstance(Components.interfaces.nsIFileInputStream);
inputStream.init(file, 0x01, 00004, null);
var bInputStream = Components.classes["@mozilla.org/binaryinputstream;1"].createInstance(Components.interfaces.nsIBinaryInputStream);
bInputStream.setInputStream(inputStream);
return(bInputStream.readBytes(inputStream.available()));
},
//}}}
//{{{
writeFile:
function(filepath,data) {
// TBD: decode base64 and write BINARY data to specified local path/filename
return(false);
},
//}}}
//{{{
askForFilename: // for FF3 fixup
function(target) {
var msg=config.messages.selectFile;
if (target && target.title) msg=target.title; // use target field tooltip (if any) as dialog prompt text
// get local path for current document
var path=getLocalPath(document.location.href);
var p=path.lastIndexOf("/"); if (p==-1) p=path.lastIndexOf("\\"); // Unix or Windows
if (p!=-1) path=path.substr(0,p+1); // remove filename, leave trailing slash
var file=""
var result=window.mozAskForFilename(msg,path,file,true); // FF3 FIXUP ONLY
if (target && result.length) // set target field and trigger handling
{ target.value=result; target.onchange(); }
return result;
}
};
//}}}
//{{{
if (window.mozAskForFilename===undefined) { // also defined by CoreTweaks (for ticket #604)
window.mozAskForFilename=function(msg,path,file,mustExist) {
if(!window.Components) return false;
try {
netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
var nsIFilePicker = window.Components.interfaces.nsIFilePicker;
var picker = Components.classes['@mozilla.org/filepicker;1'].createInstance(nsIFilePicker);
picker.init(window, msg, mustExist?nsIFilePicker.modeOpen:nsIFilePicker.modeSave);
var thispath = Components.classes['@mozilla.org/file/local;1'].createInstance(Components.interfaces.nsILocalFile);
thispath.initWithPath(path);
picker.displayDirectory=thispath;
picker.defaultExtension='';
picker.defaultString=file;
picker.appendFilters(nsIFilePicker.filterAll|nsIFilePicker.filterText|nsIFilePicker.filterHTML);
if (picker.show()!=nsIFilePicker.returnCancel)
var result=picker.file.path;
}
catch(ex) { displayMessage(ex.toString()); }
return result;
}
}
//}}}
/***
|Name|AttachFilePluginFormatters|
|Source|http://www.TiddlyTools.com/#AttachFilePluginFormatters|
|Version|4.0.1|
|Author|Eric Shulman|
|License|http://www.TiddlyTools.com/#LegalStatements|
|~CoreVersion|2.1.3|
|Type|plugin|
|Description|run-time library for displaying attachment tiddlers|
Runtime processing for //rendering// attachment tiddlers created by [[AttachFilePlugin]]. Attachment tiddlers are tagged with<<tag attachment>>and contain binary file content (e.g., jpg, gif, pdf, mp3, etc.) that has been stored directly as base64 text-encoded data or can be loaded from external files stored on a local filesystem or remote web server. Note: after creating new attachment tiddlers, you can remove [[AttachFilePlugin]], as long as you retain //this// tiddler (so that images can be rendered later on).
!!!!!Formatters
<<<
This plugin extends the behavior of the following TiddlyWiki core "wikify()" formatters:
* embedded images: {{{[img[tooltip|image]]}}}
* linked embedded images: {{{[img[tooltip|image][link]]}}}
* external/"pretty" links: {{{[[label|link]]}}}
''Please refer to AttachFilePlugin (source: http://www.TiddlyTools.com/#AttachFilePlugin) for additional information.''
<<<
!!!!!Revisions
<<<
2009.10.10 [4.0.1] in fileExists(), check for IE to avoid hanging Chrome during startup
2009.06.04 [4.0.0] changed attachment storage format to use //sections// instead of embedded substring markers.
2008.01.08 [*.*.*] plugin size reduction: documentation moved to ...Info
2007.12.04 [*.*.*] update for TW2.3.0: replaced deprecated core functions, regexps, and macros
2007.10.29 [3.7.0] more code reduction: removed upload handling from AttachFilePlugin (saves ~7K!)
2007.10.28 [3.6.0] removed duplicate formatter code from AttachFilePlugin (saves ~10K!) and updated documentation accordingly. This plugin ([[AttachFilePluginFormatters]]) is now //''required''// in order to display attached images/binary files within tiddler content.
2006.05.20 [3.4.0] through 2007.03.01 [3.5.3] sync with AttachFilePlugin
2006.05.13 [3.2.0] created from AttachFilePlugin v3.2.0
<<<
!!!!!Code
***/
// // version
//{{{
version.extensions.AttachFilePluginFormatters= {major: 4, minor: 0, revision: 1, date: new Date(2009,10,10)};
//}}}
//{{{
if (config.macros.attach==undefined) config.macros.attach= { };
//}}}
//{{{
if (config.macros.attach.isAttachment==undefined) config.macros.attach.isAttachment=function (title) {
var tiddler = store.getTiddler(title);
if (tiddler==undefined || tiddler.tags==undefined) return false;
return (tiddler.tags.indexOf("attachment")!=-1);
}
//}}}
//{{{
// test for local file existence - returns true/false without visible error display
if (config.macros.attach.fileExists==undefined) config.macros.attach.fileExists=function(f) {
if(window.Components) { // MOZ
try { netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); }
catch(e) { return false; } // security access denied
var file = Components.classes["@mozilla.org/file/local;1"].createInstance(Components.interfaces.nsILocalFile);
try { file.initWithPath(f); }
catch(e) { return false; } // invalid directory
return file.exists();
}
else if (config.browser.isIE) { // IE
var fso = new ActiveXObject("Scripting.FileSystemObject");
return fso.FileExists(f);
}
else return true; // other browsers: assume file exists
}
//}}}
//{{{
if (config.macros.attach.getAttachment==undefined) config.macros.attach.getAttachment=function(title) {
// extract embedded data, local and remote links (if any)
var text=store.getTiddlerText(title,'');
var embedded=store.getTiddlerText(title+'##data','').trim();
var locallink=store.getTiddlerText(title+'##file','').trim();
var remotelink=store.getTiddlerText(title+'##url','').trim();
// backward-compatibility for older attachments (pre 4.0.0)
var startmarker="---BEGIN_DATA---\n";
var endmarker="\n---END_DATA---";
var pos=0; var endpos=0;
if ((pos=text.indexOf(startmarker))!=-1 && (endpos=text.indexOf(endmarker))!=-1)
embedded="data:"+(text.substring(pos+startmarker.length,endpos)).replace(/\n/g,'');
if ((pos=text.indexOf("/%LOCAL_LINK%/"))!=-1)
locallink=text.substring(text.indexOf("|",pos)+1,text.indexOf("]]",pos));
if ((pos=text.indexOf("/%REMOTE_LINK%/"))!=-1)
remotelink=text.substring(text.indexOf("|",pos)+1,text.indexOf("]]",pos));
// if there is a data: URI defined (not supported by IE)
if (embedded.length && !config.browser.isIE) return embedded;
// document is being served remotely... use remote URL (if any) (avoids security alert)
if (remotelink.length && document.location.protocol!="file:")
return remotelink;
// local link only... return link without checking file existence (avoids security alert)
if (locallink.length && !remotelink.length)
return locallink;
// local link, check for file exist... use local link if found
if (locallink.length) {
locallink=locallink.replace(/^\.[\/\\]/,''); // strip leading './' or '.\' (if any)
if (this.fileExists(getLocalPath(locallink))) return locallink;
// maybe local link is relative... add path from current document and try again
var pathPrefix=document.location.href; // get current document path and trim off filename
var slashpos=pathPrefix.lastIndexOf("/"); if (slashpos==-1) slashpos=pathPrefix.lastIndexOf("\\");
if (slashpos!=-1 && slashpos!=pathPrefix.length-1) pathPrefix=pathPrefix.substr(0,slashpos+1);
if (this.fileExists(getLocalPath(pathPrefix+locallink))) return locallink;
}
// no embedded data, no local (or not found), fallback to remote URL (if any)
if (remotelink.length) return remotelink;
// attachment URL doesn't resolve, just return input as is
return title;
}
//}}}
//{{{
if (config.macros.attach.init_formatters==undefined) config.macros.attach.init_formatters=function() {
if (this.initialized) return;
// find the formatter for "image" and replace the handler
for (var i=0; i<config.formatters.length && config.formatters[i].name!="image"; i++);
if (i<config.formatters.length) config.formatters[i].handler=function(w) {
this.lookaheadRegExp.lastIndex = w.matchStart;
var lookaheadMatch = this.lookaheadRegExp.exec(w.source)
if(lookaheadMatch && lookaheadMatch.index == w.matchStart) // Simple bracketted link
{
var e = w.output;
if(lookaheadMatch[5])
{
var link = lookaheadMatch[5];
// ELS -------------
var external=config.formatterHelpers.isExternalLink(link);
if (external)
{
if (config.macros.attach.isAttachment(link))
{
e = createExternalLink(w.output,link);
e.href=config.macros.attach.getAttachment(link);
e.title = config.macros.attach.linkTooltip + link;
}
else
e = createExternalLink(w.output,link);
}
else
e = createTiddlyLink(w.output,link,false,null,w.isStatic);
// ELS -------------
addClass(e,"imageLink");
}
var img = createTiddlyElement(e,"img");
if(lookaheadMatch[1])
img.align = "left";
else if(lookaheadMatch[2])
img.align = "right";
if(lookaheadMatch[3])
img.title = lookaheadMatch[3];
img.src = lookaheadMatch[4];
// ELS -------------
if (config.macros.attach.isAttachment(lookaheadMatch[4]))
img.src=config.macros.attach.getAttachment(lookaheadMatch[4]);
// ELS -------------
w.nextMatch = this.lookaheadRegExp.lastIndex;
}
}
//}}}
//{{{
// find the formatter for "prettyLink" and replace the handler
for (var i=0; i<config.formatters.length && config.formatters[i].name!="prettyLink"; i++);
if (i<config.formatters.length) {
config.formatters[i].handler=function(w) {
this.lookaheadRegExp.lastIndex = w.matchStart;
var lookaheadMatch = this.lookaheadRegExp.exec(w.source);
if(lookaheadMatch && lookaheadMatch.index == w.matchStart) {
var e;
var text = lookaheadMatch[1];
if(lookaheadMatch[3]) {
// Pretty bracketted link
var link = lookaheadMatch[3];
if (config.macros.attach.isAttachment(link)) {
e = createExternalLink(w.output,link);
e.href=config.macros.attach.getAttachment(link);
e.title=config.macros.attach.linkTooltip+link;
}
else e = (!lookaheadMatch[2] && config.formatterHelpers.isExternalLink(link))
? createExternalLink(w.output,link)
: createTiddlyLink(w.output,link,false,null,w.isStatic);
} else {
e = createTiddlyLink(w.output,text,false,null,w.isStatic);
}
createTiddlyText(e,text);
w.nextMatch = this.lookaheadRegExp.lastIndex;
}
}
} // if "prettyLink" formatter found
this.initialized=true;
}
//}}}
//{{{
config.macros.attach.init_formatters(); // load time init
//}}}
//{{{
if (TiddlyWiki.prototype.coreGetRecursiveTiddlerText==undefined) {
TiddlyWiki.prototype.coreGetRecursiveTiddlerText = TiddlyWiki.prototype.getRecursiveTiddlerText;
TiddlyWiki.prototype.getRecursiveTiddlerText = function(title,defaultText,depth) {
return config.macros.attach.isAttachment(title)?
config.macros.attach.getAttachment(title):this.coreGetRecursiveTiddlerText.apply(this,arguments);
}
}
//}}}
/***
|Name|AttachFilePluginInfo|
|Source|http://www.TiddlyTools.com/#AttachFilePlugin|
|Documentation|http://www.TiddlyTools.com/#AttachFilePluginInfo|
|Version|4.0.0|
|Author|Eric Shulman|
|License|http://www.TiddlyTools.com/#LegalStatements|
|~CoreVersion|2.1|
|Type|plugin|
|Description|Documentation for AttachFilePlugin|
Store or link binary files (such as jpg, gif, pdf or even mp3) within your ~TiddlyWiki document and then use them as images or links from within your tiddler content.
!!!!!Inline interface (live)
>see [[AttachFile]] (shadow tiddler)
><<tiddler AttachFile>>
!!!!!Syntax
<<<
''To display the attach file control panel, simply view the [[AttachFile]] shadow tiddler that is automatically created by the plugin, and contains an instance of the inline control panel.''. Or, you can write:
{{{
<<attach inline>>
}}}
in any tiddler to display the control panel embedded within that tiddler. Note: you can actually use any unique identifier in place of the "inline" keyword. Each unique id creates a separate instance of the controls. If the same ID is used in more than one tiddler, then the control panel is automatically moved to the most recently rendered location. Or, you can write:
{{{
<<attach>>
}}}
(with no ID parameter) in ~SidebarOptions. This adds a command link that opens the controls as a floating panel, positioned directly to the left of the sidebar.
<<<
!!!!!Usage
<<<
Binary file content can be stored in three different locations:
#embedded in the attachment tiddler (encoded as base64)
#on your filesystem (a 'local link' path/filename)
#on a web server (a 'remote link' URL)
The plugin creates an "attachment tiddler" for each file you attach. Regardless of where you store the binary content, your document can refer to the attachment tiddler rather than using a direct file or URL reference in your embedded image or external links, so that changing document locations will not require updating numerous tiddlers or copying files from one system to another.
> Important note: As of version 3.6.0, in order to //render// images and other binary attachments created with this plugin, you must also install [[AttachFilePluginFormatters]], which extends the behavior of the ~TiddlyWiki core formatters for embedded images ({{{[img[tooltip|image]]}}}), linked embedded images ({{{[img[tooltip|image][link]]}}}), and external/"pretty" links ({{{[[label|link]]}}}), so that these formatter will process references to attachment tiddlers as if a normal file reference had been provided. |
When you attach a file, a tiddler (tagged with<<tag attachment>>) is generated (using the source filename as the tiddler's title). The tiddler contains //''base64 text-encoded binary data''//, surrounded by {{{/%...%/}}} comment markers (so they are not visible when viewing the tiddler). The tiddler also includes summary details about the file: when it was attached, by whom, etc. and, if the attachment is an image file (jpg, gif, or png), the image is automatically displayed below the summary information.
>Note: although you can edit an attachment tiddler, ''don't change any of the encoded content below the attachment header'', as it has been prepared for use in the rest of your document, and even changing a single character can make the attachment unusable. //If needed, you ''can'' edit the header information or even the MIME type declaration in the attachment data, but be very careful not to change any of the base64-encoded binary data.//
Unfortunately, embedding just a few moderately-sized binary files using base64 text-encoding can dramatically increase the size of your document. To avoid this problem, you can create attachment tiddlers that define external local filesystem (file://) and/or remote web server (http://) 'reference' links, without embedding the binary data directly in the tiddler (i.e., uncheck "embed data" in the 'control panel').
These links provide an alternative source for the binary data: if embedded data is not found (or you are running on Internet Explorer, which does not currently support using embedded data), then the plugin tries the local filesystem reference. If a local file is not found, then the remote reference (if any) is used. This "fallback" approach also lets you 'virtualize' the external links in your document, so that you can access very large binary content such as ~PDFs, ~MP3's, and even *video* files, by using just a 'remote reference link' without embedding any data or downloading huge files to your hard disk.
Of course, when you //do// download an attached file, the local copy will be used instead of accessing a remote server each time, thereby saving bandwidth and allowing you to 'go mobile' without having to edit any tiddlers to alter the link locations...
<<<
!!!!!Syntax / Examples
<<<
To embed attached files as images or link to them from other tiddlers, use the standard ~TiddlyWiki image syntax ({{{[img[tooltip|filename]]}}}), linked image syntax ({{{[img[tooltip|filename][tiddlername]]}}}) , or "external link" syntax ({{{[[text|URL]]}}}), replacing the filename or URL that is normally entered with the title of an attachment tiddler.
embedded image data:
>{{{[img[Meow|TraceLog Dialog.png]]}}}
>[img[Meow|TraceLog Dialog.png]]
embedded image data with link to larger remote image:
>{{{[img[click for larger view|TraceLog Dialog.png][TraceLog Dialog.png]]}}}
>[img[click for larger view|TraceLog Dialog.png][TraceLog Dialog.png]]
'external' link to embedded image data:
>{{{[[click to view attachment|TraceLog Dialog.png]]}}}
>[[click to view attachment|TraceLog Dialog.png]]
'external' link to remote image:
>{{{[[click to view attachment|TraceLog Dialog.png]]}}}
>[[click to view attachment|TraceLog Dialog.png]]
regular ~TiddlyWiki links to attachment tiddlers:
>{{{[[TraceLog Dialog.png]]}}} [[TraceLog Dialog.png]]
>{{{[[TraceLog Dialog.png]]}}} [[TraceLog Dialog.png]]
<<<
!!!!!Defining MIME types
<<<
When you select a source file, a ''[[MIME|http://en.wikipedia.org/wiki/MIME]]'' file type is automatically suggested, based on filename extension. The AttachFileMIMETypes tiddler defines the list of MIME types that will be recognized by the plugin. Each MIME type definition consists of exactly two lines of text: the official MIME type designator (e.g., "text/plain", "image/gif", etc.), and a space-separated list of file extensions associated with that type. List entries are separated by "----" (horizontal rules).
<<<
!!!!!Known Limitations
<<<
Internet Explorer does not support the data: URI scheme, and cannot use the //embedded// data to render images or links. However, you can still use the local/remote link definitions to create file attachments that are stored externally. In addition, while it is relatively easy to read local //text// files, reading binary files is not directly supported by IE's ~FileSystemObject (FSO) methods, and other file I/O techniques are subject to security barriers or require additional MS proprietary technologies (like ASP or VB) that make implementation more difficult. As a result, you cannot //create// new attachment tiddlers using IE.
<<<
!!!!!Installation
<<<
Import (or copy/paste) the following tiddlers into your document:
* [[AttachFilePlugin]] (tagged with <<tag systemConfig>>)
* [[AttachFilePluginFormatters]] ("runtime distribution library") (tagged with <<tag systemConfig>>)
* ~TraceLog Dialog.png and ~TraceLog Dialog.png //(tagged with <<tag attachment>>)//
* [[AttachFileMIMETypes]] //(defines binary file types)//
> Important note: As of version 3.6.0, in order to //render// images and other binary attachments created with this plugin, you must also install [[AttachFilePluginFormatters]], which extends the behavior of the ~TiddlyWiki core formatters for embedded images ({{{[img[tooltip|image]]}}}), linked embedded images ({{{[img[tooltip|image][link]]}}}), and external/"pretty" links ({{{[[label|link]]}}}), so that these formatter will process references to attachment tiddlers as if a normal file reference had been provided. |
<<<
!!!!!Revisions
<<<
2009.06.04 4.0.0 changed attachment storage format to use //sections// instead of embedded substring markers.
2008.07.21 3.9.0 Fixup for ~FireFox 3: use HTML with separate text+button control instead of type='file' control
2008.05.12 3.8.1 automatically add 'attach' task to backstage (moved from ~BackstageTweaks)
2008.04.09 3.8.0 in onChangeSource(), if source matches current document folder, use relative reference for local link. Also, disable 'embed' when using IE (which //still// doesn't support data: URI)
2008.04.07 3.7.3 fixed typo in HTML for 'local file link' so that clicking in input field doesn't erase current path/file (if any)
2008.04.07 3.7.2 auto-create AttachFile shadow tiddler for inline interface
2008.01.08 [*.*.*] plugin size reduction: documentation moved to ...Info
2007.12.04 [*.*.*] update for ~TW2.3.0: replaced deprecated core functions, regexps, and macros
2007.12.03 3.7.1 in createAttachmentTiddler(), added optional "noshow" flag to suppress display of newly created tiddlers.
2007.10.29 3.7.0 code reduction: removed support for built-in upload to server... on-line hosting of binary attachments is left to the document author, who can upload/host files using 3rd-party web-based services (e.g. www.flickr.com, ) or stand-alone applications (e.g., FTP).
2007.10.28 3.6.0 code reduction: removed duplicate definition of image and prettyLink formatters. Rendering of attachment tiddlers now //requires// installation of AttachFilePluginFormatters
2007.03.01 3.5.3 use apply() to invoke hijacked function
2007.02.25 3.5.2 in hijack of "prettyLink", fix version check for ~TW2.2 compatibility (prevent incorrect use of fallback handler)
2007.01.09 3.5.1 onClickAttach() refactored to create separate createAttachmentTiddler() API for use with ~FileDropPluginHandlers
2006.11.30 3.5.0 in getAttachment(), for local references, add check for file existence and fallback to remote URL if local file not found. Added fileExists() to encapsulate FF vs. IE local file test function (IE FSO object code is TBD).
2006.11.29 3.4.8 in hijack for ~PrettyLink, 'simple bracketed link' opens tiddler instead of external link to attachment
2006.11.29 3.4.7 in readFile(), added try..catch around initWithPath() to handle invalid/non-existent paths better.
2006.11.09 3.4.6 REAL FIX for ~TWv2.1.3: incorporate new ~TW2.1.3 core "prettyLink" formatter regexp handling logic and check for version < 2.1.3 with fallback to old plugin code. Also, cleanup table layout in HTML (added "border:0" directly to table elements to override stylesheet)
2006.11.08 3.4.5 TEMPORARY FIX for ~TWv2.1.3: disable hijack of wikiLink formatter due to changes in core wikiLink regexp definition. //Links to attachments are broken, but you can still use {{{[img[TiddlerName]]}}} to render attachments as images, as well as {{{background:url('[[TiddlerName]]')}}} in CSS declarations for background images.//
2006.09.10 3.4.4 update formatters for 2.1 compatibility (use this.lookaheadRegExp instead of temp variable)
2006.07.24 3.4.3 in prettyLink formatter, added check for isShadowTiddler() to fix problem where shadow links became external links.
2006.07.13 3.4.2 in getAttachment(), fixed stripping of newlines so data: used in CSS will work
2006.05.21 3.4.1 in getAttachment(), fixed substring() to extract data: URI (was losing last character, which broken rendering of SOME images)
2006.05.20 3.4.0 hijack core getRecursiveTiddlerText() to support rendering attachments in stylesheets (e.g. {{{url([[TraceLog Dialog.png]])}}})
2006.05.20 3.3.6 add "description" feature to easily include notes in attachment tiddler (you can always edit to add them later... but...)
2006.05.19 3.3.5 add "attach as" feature to change default name for attachment tiddlers. Also, new optional param to specify tiddler name (disables editing)
2006.05.16 3.3.0 completed ~XMLHttpRequest handling for GET or POST to configurable server scripts
2006.05.13 3.2.0 added interface for upload feature. Major rewrite of code for clean object definitions. Major improvements in UI interaction and validation.
2006.05.09 3.1.1 add wikifer support for using attachments in links from "linked image" syntax: {{{[img[tip|attachment1][attachment2]]}}}
2006.05.09 3.1.0 lots of code changes: new options for attachments that use embedded data and/or links to external files (local or remote)
2006.05.03 3.0.2 added {{{/%...%/}}} comments around attachment data to hide it when viewing attachment tiddler.
2006.02.05 3.0.1 wrapped wikifier hijacks in initAttachmentFormatters() function to eliminate globals and avoid ~FireFox 1.5.0.1 crash bug when referencing globals
2005.12.27 3.0.0 Update for ~TW2.0. Automatically add 'excludeMissing' tag to attachments
2005.12.16 2.2.0 Dynamically create/remove attachPanel as needed to ensure only one instance of interface elements exists, even if there are multiple instances of macro embedding.
2005.11.20 2.1.0 added wikifier handler extensions for "image" and "prettyLink" to render tiddler attachments
2005.11.09 2.0.0 begin port from old ELS Design adaptation based on ~TW1.2.33
2005.07.20 1.0.0 Initial release (as adaptation)
<<<
The //~BackColor// property specifies or determines the color (RGB) of the Control's background.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~GroupBox<br />~HiddenControl<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.BackColor}}}
//control//{{{.BackColor}}} = //value//
!!!Returned values / Arguments
{{{Long}}}
!!!Remarks
!!!Error messages
|Property '~BackColor' not applicable in this context |
|Value '...' is invalid for property '~BackColor' |
!!!See also
[[BorderColor]]
[[BorderStyle]]
[[ForeColor]]
!!!Example
<<tiddler "Color example">>
<script>
if (!window.story) window.story=window;
var url=store.getTiddlerText("SiteUrl");
var title=story.findContainingTiddler(place).id.substr(7);
var permalink=encodeURIComponent(String.encodeTiddlyLink(title));
return "\n"+"|Bookmark this page » » [["+title+"|"+url+"#"+permalink+"]]|";
</script>
*sitemap.xml
<script>
var out=""
var tids=store.getTiddlers("title","excludeLists");
for (var t=0; t<tids.length; t++) {
var url="http://www.access2base.com//access2base.html"; //store.getTiddlerText("SiteUrl");
if (!url) url=document.location.href;
var permalink=encodeURIComponent(String.encodeTiddlyLink(tids[t].title));
out+="<url><loc>"+url+"#"+permalink+"</loc><lastmod>2013-01-01</lastmod></url>"+"\n";
}
return "{{{\n"+out+"\n}}}\n";
</script>
*urllist.txt
<script>
var out=""
var tids=store.getTiddlers("title","excludeLists");
for (var t=0; t<tids.length; t++) {
var url="http://www.access2base.com//access2base.html"; //store.getTiddlerText("SiteUrl");
if (!url) url=document.location.href;
var permalink=encodeURIComponent(String.encodeTiddlyLink(tids[t].title));
out+=url+"#"+permalink+"\n";
}
return "{{{\n"+out+"\n}}}\n";
</script>
The //Bookmark// property specifies uniquely the current record of the form's underlying table, query or SQL statement.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
!!!Syntax
//form//{{{.Bookmark}}}
//form//{{{.Bookmark}}} = //value//
!!!Returned values / Arguments
{{{Variant}}}
!!!Remarks
*There is no rule about the bookmark value returned by the API. That's why the argument must be of type {{{Variant}}}.
*The {{{value}}} argument refers to the record where to move to.
*The //Bookmark// property setting moves the cursor to the row identified by a valid bookmark. If the bookmark could not be located, the result set will be positioned after the last record. If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, __even an abnormal termination is possible__.
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property 'Bookmark' |
!!!See also
[[GoToRecord]]
[[setFocus]]
!!!Example
<<tiddler "Bookmark example">>
Register the actual record
//{{{
Global gvBookmark As Variant
//}}}
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
gvBookmark = ofForm.Bookmark
//}}}
Later on, for any reason, go back to same record
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
ofForm.Bookmark = gvBookmark
//}}}
The //~BorderColor// property specifies or determines the color (RGB) of a Control's border.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~CheckBox<br />~CommandButton<br />~GroupBox<br />~HiddenControl<br />~NavigationBar<br />[[RadioButton]]<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.BorderColor}}}
//control//{{{.BorderColor}}} = //value//
!!!Returned values / Arguments
{{{Long}}}
!!!Remarks
!!!Error messages
|Property '~BorderColor' not applicable in this context |
|Value '...' is invalid for property '~BorderColor' |
!!!See also
[[BackColor]]
[[BorderStyle]]
[[ForeColor]]
!!!Example
<<tiddler "Color example">>
The //~BorderStyle// property specifies or determines the style (normal, 3D) of a Control's border.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~CheckBox<br />~CommandButton<br />~GroupBox<br />~HiddenControl<br />[[RadioButton]]<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.BorderStyle}}}
//control//{{{.BorderStyle}}} = //value//
!!!Returned values / Arguments
{{{Integer}}}
!!!Remarks
The allowed values for ~BorderStyle are:
>0: No border
>1: 3D border
>2: simple border
!!!Error messages
|Property '~BorderStyle' not applicable in this context |
|Value '...' is invalid for property '~BorderStyle' |
!!!See also
[[BorderColor]]
!!!Example
<<tiddler "Color example">>
(Q) Can I list the value of all controls on a form for debugging purposes ?
(R) Use the [[Controls]] collection on objects and nested objects recursively as shown.
Consider next tables:
<<tiddler "OrdersTable">>
<<tiddler "OrderDetailsTable">>
Define a main/sub form based on those tables (wizard is perfect for making the form ...: choose a normal format for the mainform and the grid format for the subform).
Run next code:
//{{{
Sub StartBrowseThruControls(ByVal psFormName As String)
Dim oMainForm As Object
Set oMainForm = Forms(psFormName)
BrowseThruControls(oMainForm)
End Sub
Sub BrowseThruControls(poObject As Object, ByVal Optional piLevel As Integer)
Dim i As Integer, ocControl As Object
If IsMissing(piLevel) Then piLevel = 1
For i = 0 To poObject.Controls.Count - 1
Set ocControl = poObject.Controls(i)
Select Case ocControl.SubType
Case "SUBFORMCONTROL"
DebugPrint piLevel, ocControl.SubType, ocControl.Name
BrowseThruControls(ocControl.Form, piLevel + 1)
Case "GRIDCONTROL"
DebugPrint piLevel, ocControl.SubType, ocControl.Name
BrowseThruControls(ocControl, piLevel + 1)
Case Else
If ocControl.hasProperty("Value") Then DebugPrint piLevel, ocControl.SubType, ocControl.Name, ocControl.Value
End Select
Next i
End Sub
//}}}
This will produce next result in the //~Access2Base// console:
//{{{
13:23:38 ===> 1 TEXTFIELD txtShipPostalCode 51100
13:23:38 ===> 1 FORMATTEDFIELD fmtShipVia 3
13:23:38 ===> 1 DATEFIELD datRequiredDate 01/08/1996
13:23:38 ===> 1 SUBFORMCONTROL SubForm
13:23:38 ===> 2 GRIDCONTROL SubForm_Grid
13:23:38 ===> 3 FORMATTEDFIELD OrderID 10248
13:23:38 ===> 3 FORMATTEDFIELD Discount 0
13:23:38 ===> 3 FORMATTEDFIELD ProductID 11
13:23:38 ===> 3 FORMATTEDFIELD UnitPrice 14
13:23:38 ===> 3 FORMATTEDFIELD Quantity 12
13:23:38 ===> 1 DATEFIELD datShippedDate 16/07/1996
13:23:38 ===> 1 TIMEFIELD timShippedDate 0
13:23:38 ===> 1 FORMATTEDFIELD fmtEmployeeID 5
13:23:38 ===> 1 TEXTFIELD txtShipName Vins et alcools Chevalier
13:23:38 ===> 1 TIMEFIELD timRequiredDate 0
13:23:39 ===> 1 TEXTFIELD txtShipAddress 59 rue de l'Abbaye
13:23:39 ===> 1 FORMATTEDFIELD fmtOrderID 10248
13:23:39 ===> 1 FORMATTEDFIELD fmtFreight 32,38
13:23:39 ===> 1 DATEFIELD datOrderDate 04/07/1996
13:23:39 ===> 1 TEXTFIELD txtShipCountry France
13:23:39 ===> 1 TEXTFIELD txtShipCity Reims
13:23:39 ===> 1 TEXTFIELD txtShipRegion
13:23:39 ===> 1 TIMEFIELD timOrderDate 0
13:23:39 ===> 1 TEXTFIELD txtCustomerID WILMK
//}}}
It makes clear:
*that a subform is a control like any control
*that the gridcontrol is simply embedded in the subform also like any other control
!!!See also
[[DebugPrint]]
[[Form (subform)]]
[[hasProperty]]
[[SubType]]
[[TraceConsole]]
(Q) How do I simulate a calculated field on a form ? //AOO/~LibO// does not support such fields in forms while //~MSAccess// does.
(R)
*Make the calculated field {{{Enabled = False}}} in the Control properties sheet.
*Compute its content in the "After record Change" event.
Let's consider next tables:
<<tiddler OrdersTable>>
<<tiddler OrderDetailsTable>>
The goal is to have a form linked to the {{{Orders}}} table in which a //~SumOfDetails// calculated field contains the sum of the orders as found in the {{{Order Details}}} child records, computed as:
//{{{
[Order Details].[UnitPrice] * [Order Details].[Quantity] * (1 - [Order Details].[Discount])
//}}}
!!!Solution by computing the field in Basic
Store next code in the "After record Change" event of the form :
//{{{
Sub ComputeOrderTotal(poEvent As Object)
Dim oeEvent As Object, ofForm As Object, ocSum As Object, vOrderId As Variant
Set oeEvent = Events(poEvent)
If Not IsNull(oeEvent) Then
Set ofForm =oeEvent.Source
vOrderId = ofForm.Controls("OrderID").Value
Set ocSum = ofForm.Controls("SumOfDetails")
ocSum.Value = DSum("[Order Details].[UnitPrice] * [Order Details].[Quantity] * (1 - [Order Details].[Discount])" _
, "[Order Details]", "[Order Details].[OrderID]=" & vOrderId)
End If
End Sub
//}}}
!!!Solution with SQL only
This solution is preferable whenever possible.
To have an idea of the functions built in HSQLDB, look at [[HSLQB Built-in functions|http://wiki.openoffice.org/wiki/Built-in_functions_and_Stored_Procedures]].
Associate the form with next SQL command and the Calculated field with the //~TotalOrder// database field :
//{{{
SELECT "Orders"."OrderID", "Orders"."OrderDate", "Orders"."ShipAddress", "Orders"."ShipCity",
SUM( "Order Details"."UnitPrice" * "Order Details"."Quantity" * ( 1 - "Order Details"."Discount" ) ) AS "TotalOrder"
FROM "Order Details", "Orders" WHERE "Order Details"."OrderID" = "Orders"."OrderID"
GROUP BY "Orders"."OrderID", "Orders"."OrderDate", "Orders"."ShipAddress", "Orders"."ShipCity"
//}}}
!!!See also
[[Events Handler]]
[[getObject]]
[[DSum]]
[[Forms]]
[[Controls]]
The //Cancel// property specifies if a command button has or not the behaviour of a Cancel button.
!!!Applies to ...
| !Oobject | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |~CommandButton | None |A control on an open form |
!!!Syntax
//control//{{{.Cancel}}}
//control//{{{.Cancel}}} = }//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property 'Cancel' not applicable in this context |
|Value '...' is invalid for property 'Cancel' |
!!!See also
[[Default]]
!!!Example
<<tiddler "Cancel & Default example">>
Display the status of a command button
//{{{
Dim ocControl As Object
Set ocControl = getObject("Forms!myForm!cmdButton")
MsgBox "Cancel=" & ocControl.Cancel & " - Default=" & ocControl.Default
//}}}
The //Caption// property specifies the text string appearing in the title bar of a [[form|Form]].
When related to a [[Control]] the //Caption// property refers to the text associated with the control.
When the control belongs to a [[GridControl]] the //Caption// property specifies the column header.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Form]] |||An open form |
|[[Control]] | ~CheckBox<br />~CommandButton<br />~FixedText<br />~GroupBox<br />[[RadioButton]] | All |A control on an open form or within a [[GridControl]] of one of the listed types |
!!!Syntax
//form//{{{.Caption}}}
//form//{{{.Caption}}} = //value//
//control//{{{.Caption}}}
//control//{{{.Caption}}} = //value//
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property 'Caption' |
!!!Examples
<<tiddler "Caption examples">>
Display and change form title bar
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
_MsgBox ofForm.Caption
ofForm.Caption = "New title"
//}}}
Change a checkbox label
//{{{
Dim ocCheckBox As Object
ocCheckBox = getObject("Forms!myForm!myChkBox")
If ocCheckBox.Value Then
ocCheckBox.Caption = "Checked"
Else
ocCheckBox.Caption = "Unchecked"
End If
//}}}
(Q) How do I carry forward the current value of a control so that it's automatically entered for all new records?
(R) To use the current control value for new records, you need to assign it to the defaultvalue of the control.
Consider next table:
<<tiddler "CustomersTable">>
Then if a form is built on above table, link next code to the "After record change" event of the form:
//{{{
Sub SetDefaultNewRec(poEvent As Object)
Dim ofForm As Object, ocControl As Object
Set ofForm = Events(poEvent).Source ' Get the current form
Set ocControl = ofForm.Controls("txtCountry")
ocControl.DefaultValue = ocControl.Value
End Sub
//}}}
The //country// field will appear initialized with its value in the current record if the user enters a new record.
!!!See also
[[Events Handler]]
[[DefaultValue]]
[[Value]]
{{firstletter{
@@color:#930;T@@
}}}he //Close// [[action|Actions]] closes an object (table, query, form or report).
!!!Syntax
{{{mClose(}}}//{{{ObjectType, ObjectName, Save}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{ObjectType}}} | No | acTable<br />acQuery<br />acForm<br />acReport |The type of object to close. |
|{{{ObjectName}}} | No | String |The name of the object to close. This argument is NOT case-sensitive. |
|{{{Save}}} | Yes | acSavePrompt |Indicates if a prompt to the user will prevent from closing without saving. acSavePrompt is the only supported value. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acForm = 2
Global Const acQuery = 1
Global Const acReport = 3
Global Const acTable = 0
Global Const acSavePrompt = 0
//}}}
!!!Remarks
*The {{{ObjectName}}} object must exist in the database document (".odb" file). However if it is not open, the command has no effect.
*If the object is a table or a query, and the object is not open, running the //Close// action will open the Table or Query and close it immediately.
*The //Close// action is not allowed from a [[standalone form|Standalone Forms]].
!!!Error messages
|Table (or form or query or report) '...' could not be closed |
|Table (or form or query or report) '...' not found |
!!!See also
[[OpenForm]]
[[OpenQuery]]
[[OpenReport]]
[[OpenTable]]
!!!Example
//{{{
mClose(acTable, "myTable")
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //Close// method closes the targetted form.
!!!Syntax
//form//{{{.mClose()}}}
!!!Remarks
*The //Close// method is equivalent to the [[Close]] action when applied to the same form.
*The //Close// method is not allowed from a [[standalone form|Standalone Forms]].
!!!Error messages
!!!See also
[[OpenForm]]
!!!Example
//{{{
Dim ofForm As Object
ofForm = Forms("myForm")
ofForm.mClose()
//}}}
This page details the conventions used in the coding of the //~Access2Base// API.
!!Library and Modules
*The acConstants module lists constants that are used in the API. They are defined as //Global//. Their name is identical as in ~MSAccess. Their value is in most cases identical to that of ~MSAccess, however not always. The scope of global constants is limited to one single library. As a consequence their definition may freely be copied and pasted to make them available in user libraries.
*The reserved words are //~Proper-Cased// showing the same appearance as in the IDE of ~MSAccess.
!!Functions and Subroutines
*~OpenOffice/~LibreOffice ignores the Private/Public attribute in Functions or Subs declarations. Nevertheless the attribute must be present. Rules for use are:
| !Attribute | !Sub/Function Naming | !When |
|Public |Starts with a letter |The Sub/Function belongs to the ~Access2Base API. As such it may be called from any other library developed by the user. |
|Public |Starts with an underscore "_" |The Sub/Function must be called only from within the ~Access2Base library. As such it MUST NOT be called from another library as there is no guarantee about the arguments, the logic or even the existence of that piece of code in a later release. |
|Private |The Sub/Function must start with an underscore "_" |The Sub/Function must be called only from the module in which it is located |
*Functions and Subroutines belonging to the API (= "standard" functions/Subs) are stored in their module in alphabetical order.
*Functions and Subroutines not belonging to the API are stored in their module in alphabetical order below the standard ones.
*The return value of a function is always declared explicitly.
*The parameters are always declared explicitly even if they're variants.
*The Function and Sub declarations start at the 1^^st^^ column of the line.
*The End Function/Sub statement is followed by a comment reminding the name of the function or sub.
!!Variable declarations
*The //Option Explicit// statement is mandatory in every module.
*The Global, Dim and Const statements always start in the first column of the line.
*The type (Dim ... As ..., Function ... As ...) is always declared explicitly, even if the type is Variant.
*Variables are //~Proper-Cased//. They are always preceded by a lower-case letter indicating their type. With next exception: variables i, j, k, l, m and n must be declared as integers.
| !First letter | !Type |
| b |Boolean |
| d |Date |
| v |Variant |
| o |Object |
| i |Integer |
| l |Long|
| s |String |
{{indent{Example:{{{ Dim sValue As String}}}
*Parameters are preceded by the letter //p// which itself precedes the single typing letter. Like in:<br />{{{Public Function MyFunction(psValue As String) As Variant}}}
*Object variables are preceded by the letter o followed by their type:
| !First letter | !Type |
| db |Database |
| f |Form or Subform |
| c |Control |
| e |Event |
| p |Property |
{{indent{like in:{{{ Dim ocControl As Object}}}
*Global variables in the ~Access2Base library are ALL preceded by an underscore "_" as NONE of them should be invoked from outside the library.
*Constant values with a local scope are //~Proper-Cased// and preceded by the letters //cst//.
*Constants with a global scope are //~UPPER-CASED//
Example
//{{{
Global Const ACONSTANT = "This is a global constant"
Function MyFunction(pocControl As Object, piValue) As Variant
Dim iValue As Integer
Const cstMyConstant = 3
//}}}
!Goto
The //Goto// statement is forbidden.
It is however highly recommended for __error__ and __exception__ handling.
A //Collection// contains a list of other objects.
The individual members of the collection are accessible either via their index or via their name. The name is NOT case-sensitive.
!!!Collections
A //Collection// object is returned by next functions
| !Function |!Description |
|[[AllForms]] |{{{AllForms()}}} without argument returns the //Collection// of all forms defined in the current Base document |
|[[Forms]] |{{{Forms()}}} without argument returns the //Collection// of all open forms |
|[[Controls]] |{{{myObject.Controls}}} returns the //Collection// of all the controls of a //form//, a //subform// or a //gridcontrol// designated by the object //myObject// |
|[[Properties]] |{{{myObject.Properties}}} returns the //Collection// of all properties of the object //myObject// |
!!!Properties
| !Property |!Description |
|[[Count]] |Number of items in the //Collection//. The first item of the //Collection// has the range //0//; the last one has the range //Count - 1// |
!!!Methods
None
!!!Example
<<tiddler "Collection example">>
To display the name of all forms
//{{{
Dim i As Integer, oCollection As Object
Set oCollection = AllForms
For i = 0 To oCollection.Count - 1 'AllForms without argument returns a Collection object
Print AllForms(i).Name, 'AllForms(...) with an argument returns a Form object
Next i
Print
//}}}
Modify colors depending on value in field (typically in After Record Change form event)
//{{{
Dim ocControl As Object, vValue As Variant
Dim lBlack As Long, lRed As Long, lYellow As Long, lWhite As Long
Set ocControl = getObject("Forms!myForm!myControl")
vValue = getValue(ocControl)
If Not IsNull(vValue) Then
lRed = RGB(255, 0, 0)
lBlack = RGB(0, 0, 0)
lYellow = RGB(255, 255, 0)
lWhite = RGB(255, 255, 255)
With ocControl
If vValue > 100 Then
.BorderColor = lRed
.ForeColor = lRed
.BackColor = lYellow
.BorderStyle = 2
Else
.BorderColor = lBlack
.ForeColor = lBlack
.BackColor = lWhite
.BorderStyle = 0
End If
End With
End If
//}}}
{{firstletter{
@@color:#930;A@@
}}} //~ComboBox// describes a combo box control. It has specific properties to manage the input list of potential values and to select one of them programmatically.
A ~ComboBox control is returned by the [[Controls]] collection or by the [[getObject]] shortcut.
!!!Specific properties for combo box management
| !Property | !Read only | !Description |
|[[ItemData]] | Y |Returns the data for the specified row in a ~ComboBox or [[ListBox]]. |
|[[ListCount]] | Y |Determines the number of rows in a [[ListBox]] or the list box portion of a ~ComboBox. |
|[[ListIndex]] ||Determines which item is selected in a [[ListBox]] or a ~ComboBox. |
|[[RowSource]] ||Specifies the source of the data in a [[ListBox]] or a ~ComboBox. |
|[[RowSourceType]] ||Specifies the source (tablename, queryname or SQL statement) of the data in a [[ListBox]] or a ~ComboBox. |
|[[Value]] ||Specifies the value contained in the ~ComboBox. |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the ~ComboBox has the given property. |
|[[Requery]] || Boolean |True if data reloaded in ~ComboBox |
!!!Remarks
!!!See also
[[ListBox]]
!!!Example
<<tiddler "ComboBox example">>
Display the options of the combo
//{{{
Dim i As Integer, ocCombo As Object
Set ocCombo = getObject("Forms!myForm!myComboBox")
For i = 0 To ocCombo.ListCount - 1
Print i & " - " & ocCombo.ItemData(i)
Next i
//}}}
Modify current selection position and find new value
//{{{
Dim ocCombo As Object
ocCombo.ListIndex = 2
Print ocCombo.Value
Print//}}}
//}}}
*To contribute to this piece of software ...
*To search for help about its use ...
*For any question you could have ...
If your request is of public interest, post it on the [[OpenOffice Community forum|http://forum.openoffice.org/en/forum/]] preferably in the //Base// or //Macros and API// rubric.
Otherwise, send a private message to the user "JPL" on the same forum. Messages in english, french or dutch are welcome.
!Proposals for contributions to translations of ~Access2Base into other languages should be addressed via a private message.
(Translating into a new language takes +/- 2 hours ...)
{{firstletter{
@@color:#930;A@@
}}} //Control// [[object|Object Model]] describes one of the Controls of an open [[form|Form]], a [[subform|SubForm]], a [[gridcontrol|GridControl]] or an [[options group|OptionGroup]]. Each control will be retrieved as a member of the [[Controls]] [[collection|Collection]] of its corresponding parent.
NB: Subforms and gridcontrols are themselves controls and retrieved like other controls as a member of a collection.
!!!Functions returning a control object
| !Function | !Type | !Arguments |!Description |
|[[Controls]] | [[Collection]] | None<br />Integer, Long<br />String |{{{Forms("myForm").Controls("myControl")}}}<br />Returns an object of type {{{Control}}} referring to the {{{myControl}}} control in the {{{myForm}}} form. {{{myForm}}} must be open. |
|[[getObject]] || String |{{{getObject("Forms!myForm!myControl")}}} returns an object referring to the {{{myControl}}} control in the {{{myForm}}} form. {{{myForm}}} must be open. |
!!!Control types
The types of control can be recognized thru the use either of the [[SubType]] (string) or the [[ControlType]] (integer) properties. The ~ControlType property is there for compatibility with ~MSAccess but has the disadvantage to not discriminate control types 100%, e.g. a ~TextField cannot be distinguished from a ~FormattedField control type.
See the correspondence table below.
<<tiddler "ControlTypesList">>
!!!Properties
| !Property | !Type | !Read only |!Description or UNO object |
|[[Name]] || Y |Specifies the exact name of the control |
|BackColor (*) |||Specifies the color of the interior of a control. |
|BorderColor (*) |||Specifies the color of a control's border. |
|BorderStyle (*) |||Specifies how a control's border appears. |
|[[Cancel]] (*) |||Specifies whether a command button is also the Cancel button on a form. |
|[[Caption]] |||Specifies the label associated with a control.<br />If the control is located within a ~GridControl, the Caption specifies the column heading. |
|[[ControlSource]] || Y |Specifies what data appears in a control. |
|[[ControlTipText]] |||Specifies the text that appears in a ~ScreenTip when you hold the mouse pointer over a control. |
|[[ControlType]] || Y |Specifies the type of a control. |
|[[Default]] (*) |||specifies whether a ~CommandButton is the default button on a form. |
|[[DefaultValue]] |||Specifies a value that is automatically entered in a field when a new record is created. |
|[[Enabled]] |||Specifies if the cursor can access the control. |
|[[FontBold]]<br />[[FontItalic]]<br />[[FontName]]<br />[[FontSize]]<br />[[FontUnderline]]<br />[[FontWeight]]<br />[[ForeColor]]<br />(*) |||Specify the font characteristics. |
|[[Form|Form (subform)]] (*) || Y |Returns the [[SubForm]] object corresponding with the ~SubForm control. |
|[[Format]] || Y |Returns the way numbers, dates, times, and text are displayed |
|[[ItemData]] || Y |Returns the data for the specified row in a combo box or list box. |
|[[ListCount]] || Y |Determines the number of rows in a [[ListBox]] or the list box portion of a [[ComboBox]]. |
|[[ListIndex]] |||Determines which item is selected in a [[ListBox]] or a [[ComboBox]]. |
|[[Locked]] |||Specifies whether you can edit data in a control. |
|[[MultiSelect]] (*) |||Specifies whether a user can make multiple selections in a [[ListBox]] on a form. |
|[[ObjectType]] || Y |Returns "CONTROL" |
|[[OptionValue]] (*) || Y |Specifies the value that is stored in the database when a [[RadioButton]] is selected and the record saved. |
|[[Parent]] || Y |returns the parent object of the control. |
|[[Required]] |||Specifies whether a control must contain a value when the record is edited. |
|[[RowSource]] |||Specifies the source of the data in a [[ListBox]] or a [[ComboBox]]. |
|[[RowSourceType]] |||Specifies the source (tablename, queryname or SQL statement) of the data in a [[ListBox]] or a [[ComboBox]]. |
|[[Selected]] |||Specifies if an item in the data proposed by a [[ListBox]] is currently selected. |
|[[SubType]] || Y |Specifies the type of a control. |
|[[TabIndex]] (*) |||Specifies a control's place in the tab order on a form. |
|[[TabStop]] (*) |||Specifies whether you can use the TAB key to move the focus to a control. |
|[[Tag]] |||Stores extra information about a control. |
|[[Text]] || Y |Sets or returns the text contained in a text box (or similar). |
|[[TextAlign]] |||Specifies the alignment of the text in a control. |
|[[TripleState]] |||Specifies how a //~CheckBox// wll display Null values. |
|[[Value]] |||Specifies the value contained in a control. |
|[[Visible]] (*) |||Specifies if a control is visible or hidden. |
|~ControlModel | UNO | Y |com.sun.star.comp.forms.~XXXModel |
|~ControlView | UNO | Y |com.sun.star.comp.forms.~XXXControl |
|~BoundField | UNO | Y |com.sun.star.sdb.~ODataColumn |
|~LabelControl | UNO | Y |com.sun.star.form.component.~FixedText or com.sun.star.form.component.~GroupBox |
(*) Not applicable to controls belonging to a [[GridControl]].
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the Control has the given property. |
|[[setFocus]] | none | Boolean |Return True if focus set on Control successfully. |
!!!Remarks
!!!Example
<<tiddler "Control example">>
List all the controls of a form having the Visible property
//{{{
Dim ofForm As Object, ocControl As Object, i As Integer, iCount As Integer
Set ofForm = Forms("myForm")
iCount = ofForm.Controls.Count
For i = 0 To iCount - 1
Set ocControl = ofForm.Controls(i)
If ocControl.hasProperty("Visible") Then Print ocControl.Name & ":" & ocControl.SubType
Next i
Print
//}}}
The //~ControlSource// property specifies the database field bound to the [[Control]].
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | ~CheckBox<br />~ComboBox<br />~CurrencyField<br />~DateField<br />~FormattedField<br />~ImageControl<br />[[ListBox]]<br />~NumericField<br />~PatternField<br />[[RadioButton]]<br />~TextField<br />~TimeField | All |A control on an open form or within a [[GridControl]] of one of the allowed types |
!!!Syntax
//control//{{{.ControlSource}}}
!!!Returned value
{{{String}}}
!!!Remarks
The //~ControlSource// property is read-only.
!!!Error messages
|Property '~ControlSource' not applicable in this context |
!!!See also
[[RecordSource]]
!!!Example
<<tiddler "ControlSource example">>
Display the bound database field
//{{{
Dim ocControl As Object
Set ocControl = getObject("Forms!myForm!myGridControl!myTextField")
MsgBox ocControl.ControlSource
//}}}
The //~ControlTipText// property specifies the text that appears in a ~ScreenTip when you hold the mouse pointer over a control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />[[SubForm]]-- | All |A control on an open form or within a [[GridControl]] of one of the listed types |
!!!Syntax
//control//{{{.ControlTipText}}}
//control//{{{.ControlTipText}}} = }//value//{{{)}}}
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
!!!Error messages
|Property '~ControlTipText' not applicable in this context |
|Value '...' is invalid for property '~ControlTipText' |
!!!See also
!!!Example
<<tiddler "ControlTipText example">>
Change the tip text of a control
//{{{
Dim ocControl As Object
Set ocControl = getObject("Forms!myForm!myControl")
ocControl.ControlTipText = "This is a new tip !"
//}}}
The types of control can be recognized thru the use either of the [[SubType]] or the //~ControlType// properties. The ~ControlType property is there for compatibility with ~MSAccess but has the disadvantage to not discriminate control types 100%, e.g. a ~TextField cannot be distinguished from a ~FormattedField control type.
See the correspondence table below.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | All | All |A control on an open form |
!!!Syntax
//control//{{{.ControlType}}}
!!!Returned values
{{{Integer}}}
Table of values:
<<tiddler "ControlTypesList">>
Instead of using the numeric values for ~ControlType, one may copy next code and paste it in his/her own code. This allows to use symbolic names, more or less compatible with those existing in ~MSAccess. "More or less" as many control types do not match: e.g. a "spin button" is unknown in ~MSAccess.
//{{{
REM Control Types
REM -----------------------------------------------------------------
Global Const acCheckBox = 5
Global Const acComboBox = 7
Global Const acCommandButton = 2: Global Const acToggleButton = 122
Global Const acCurrencyField = 18
Global Const acDateField = 15
Global Const acFileControl = 12
Global Const acFixedText = 10 : Global Const acLabel = 10
Global Const acFormattedField = 1
Global Const acGridControl = 11
Global Const acGroupBox = 8 : Global Const acOptionGroup = 8
Global Const acHiddenControl = 13
Global Const acImageButton = 4
Global Const acImageControl = 14: Global Const acImage = 14
Global Const acListBox = 6
Global Const acNavigationBar = 22
Global Const acNumericField = 17
Global Const acPatternField = 19
Global Const acRadioButton = 3 : Global Const acOptionButton = 3
Global Const acScrollBar = 20
Global Const acSpinButton = 21
Global Const acSubform = 112
Global Const acTextField = 9 : Global Const acTextBox = 9
Global Const acTimeField = 16
//}}}
!!!Remarks
The ~ControlType property is read-only.
!!!Error messages
!!!See also
[[SubType]]
!!!Example
<<tiddler "ControlType example">>
List name, controltype and subtype of all controls on an open form
//{{{
Dim ofForm As Object, ocControl As Object, i As Integer, iCount As Integer
Set ofForm = Forms("myForm")
iCount = ofForm.Controls.Count
For i = 0 To iCount - 1
Set ocControl = ofForm.Controls(i)
Print ocControl.Name & "/" & ocControl.SubType & "/" & ocControl.ControlType
Next i
Print
//}}}
| !~SubType | !~ControlType |Allowed in [[GridControls|GridControl]] |
|CHECKBOX | 5 | Y |
|[[COMBOBOX|ComboBox]] | 7 | Y |
|COMMANDBUTTON | 2 ||
|CURRENCYFIELD | 18 | Y |
|DATEFIELD | 15 | Y |
|FILECONTROL | 12 ||
|FIXEDTEXT | 10 ||
|FORMATTEDFIELD | 1 | Y |
|[[GRIDCONTROL|GridControl]] | 11 ||
|GROUPBOX | 8 ||
|HIDDENCONTROL | 13 ||
|IMAGEBUTTON | 4 ||
|IMAGECONTROL | 14 ||
|[[LISTBOX|ListBox]] | 6 | Y |
|NAVIGATIONBAR | 22 ||
|NUMERICFIELD | 17 | Y |
|PATTERNFIELD | 19 | Y |
|[[RADIOBUTTON|RadioButton]] | 3 ||
|SCROLLBAR | 20 ||
|SPINBUTTON | 21 ||
|[[SUBFORMCONTROL|SubForm]] | 112 ||
|TEXTFIELD | 9 | Y |
|TIMEFIELD | 16 | Y |
The //Controls// collection describes instances of all __controls__ present either
*in an open [[form|Form]]
*in a [[subform|SubForm]] of an open form of or another subform
*in a [[GridControl]] part of an open form or one of its subforms
*or in an [[OptionGroup]] (i.e. a set of [[radio buttons|RadioButton]])
!!!Syntax
//form//{{{.Controls}}}
{{{Controls(}}}//formname//{{{)}}}
//form//{{{.Controls(}}}//index//{{{)}}}
{{{Controls(}}}//formname//{{{, index)}}}
//form//{{{.Controls(}}}//controlname//{{{)}}}
{{{Controls(}}}//formname, controlname//{{{)}}}
//subform//{{{.Controls}}}
//subform//{{{.Controls(}}}//index//{{{)}}}
//subform//{{{.Controls(}}}//controlname//{{{)}}}
//gridcontrol//{{{.Controls}}}
//gridcontrol//{{{.Controls(}}}//index//{{{)}}}
//gridcontrol//{{{.Controls(}}}//controlname//{{{)}}}
//optiongroup//{{{.Controls}}}
//optiongroup//{{{.Controls(}}}//index//{{{)}}}
| !Object | !Type | !Argument | !Type |!Returned value |
| form | [[Form object|Form]] || absent |A [[Collection]] of the controls of the form |
| formname | String |~|~|~|
| form | [[Form object|Form]] | index | integer<br />long |A [[control object|Control]] |
| formname | String |~|~|~|
| form | [[Form object|Form]] | controlname | string |~|
| formname | string |~|~|~|
| subform | [[Subform object|SubForm]] || absent |A [[Collection]] of the controls of the subform |
|~|~| index | integer<br />long |A [[control object|Control]] |
|~|~| controlname | string |~|
| gridcontrol | [[Gridcontrol object|GridControl]] || absent |A [[Collection]] of the controls of the gridcontrol |
|~|~| index | integer<br />long |A [[control object|Control]] |
|~|~| controlname | string |~|
| optiongroup | [[Optiongroup object|OptionGroup]] || absent |A [[Collection]] of the controls of the optiongroup |
|~|~| index | integer<br />long |A [[control object|Control]] of [[SubType]] [[RadioButton]]. |
!!!Remarks
*~Access2Base does not support a hierarchy of form names although Base does it. Only single form names are allowed.
*Control [[collections|Collection]] are numbered from 0 to {{{Controls(...).Count - 1}}}
*The //formname// and //controlname// arguments are not case sensitive.
*The //index// of an [[OptionGroup]] is determined by its position (~X-Y coordinates) on the screen: 1) top to bottom 2) left to right.
!!!Error messages
|Argument nr.X is invalid |
|Out of array range or incorrect array size for collection Controls() |
|Form '...' not found |
|Form '...' is currently not open|
|Control '...' not found in parent (form or grid) '...' |
!!!Examples
<<tiddler "Controls examples">>
To identify the last control of an open form
//{{{
Dim ofForm As Object, iCount As Integer
Set ofForm = Forms("myForm")
iCount = ofForm.Controls.Count
MsgBox "The form " & ofForm.Name & " has " & iCount & " controls." _
& "The last one is " & ofForm.Controls(iCount - 1).Name
//}}}
To know the controls present in a gridcontrol (datagrid)
//{{{
Dim ocGrid As Object, i As Integer, iCountGrid As Integer
Set ocGrid = Controls("myform", "myGridControl")
iCountGrid = ocGrid.Controls.Count
For i = 0 To iCountGrid - 1
Print ocGrid.Controls(i).Name
Next i
Print
//}}}
The //Count// property identifies the number of items present in a [[collection|Collection]].
!!!Applies to ...
| !Collection |!Description |
| [[AllForms]] |All forms, open or closed, in the current database document (".odb" file) |
| [[Controls]] |All controls of an open form |
| [[Forms]] |All open forms |
| [[Properties]] |All properties of an [[object|Object Model]] |
| !Control |!Description |
| [[OptionGroup]] |Groups the [[Radio buttons|RadioButton]] with the same name within a form. |
!!!Syntax
//collection//{{{.Count}}}
//control//{{{.Count}}}
//optiongroup//{{{.Count}}}
!!!Returned values
{{{Integer}}} >= 0
!!!Remarks
*The //Count// property is read-only.
*The items of the [[collection|Collection]] or of the [[OptionGroup]] control are always numbered from 0 to {{{Count - 1}}}
!!!Error messages
!!!Example
<<tiddler "Count example">>
The following example uses the Count property to control a loop that prints information about all open forms and their controls.
//{{{
Dim ofForm As Object, i As Integer
Dim j As Integer
Dim iControls As Integer, iForms As Integer
iForms = Forms.Count ' Number of open forms.
If iForms > 0 Then
For i = 0 To iForms - 1
Set ofForm = Forms(i)
_Print ofForm.Name
iControls = ofForm.Controls().Count
If iControls > 0 Then
For j = 0 To iControls - 1
Print ofForm.Controls(j).Name
Next j
End If
Next i
End If
Print
//}}}
The //~CurrentDb// method returns the current [[database|Database]] object..
!!!Syntax
{{{CurrentDb()}}}
!!!Returned values / Arguments
{{{Database}}} object or {{{Null}}}
!!!Remarks
The ~CurrentDb method returns {{{Null}}} if there is currently no database connected. In case of unwanted disconnection The [[OpenConnection]] //sub// may be (re)executed to (re)create a valid connection.
!!!Error messages
None
!!!See also
[[Database]]
[[OpenConnection]]
!!!Example
<<tiddler "CurrentDb example">>
Reconnect database after unwanted disconnection
//{{{
If IsNull(CurrentDb) Then Call OpenConnection(ThisDatabaseDocument)
//}}}
*Customers table
| !Fields | !Field Type | !Primary |
|Address | Text ||
|City | Text ||
|~CompanyName | Text ||
|~ContactName | Text ||
|Country | Text ||
|~CustomerID | Text | Y |
|Fax | Text ||
|Phone | Text ||
|~PostalCode | Text ||
|Region | Text ||
You can use the ~DAvg function to determine the average of a set of values in a specified set of records (a domain).
!!!Syntax
{{{DAvg(expression, domain[, criteria])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DAvg function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the ~DAvg function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
!!!Returned value
{{{Variant}}}
!!!Remarks
*All //expression//, //domain// and //criteria// arguments may use database record- or fieldnames surrounded wit square brackets [].
*If no record satisfies //criteria// or if //domain// contains no records, the ~DAvg function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DCount]]
[[DLookup]]
[[DMin, DMax]]
[[DStDev, DStDevP]]
[[DSum]]
[[DVar, DVarP]]
!!!Example
<<tiddler "Dfunctions example">>
You can use the ~DCount function to determine the number of records that are in a specified set of records (a domain).
!!!Syntax
{{{DCount(expression, domain[, criteria])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DCount function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the DCount function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
!!!Returned value
{{{Integer}}} or {{{Long Variant}}}
!!!Remarks
*All //expression//, //domain// and //criteria// arguments may use database record- or fieldnames surrounded wit square brackets [].
*If no record satisfies //criteria// or if //domain// contains no records, the ~DCount function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DAvg]]
[[DLookup]]
[[DMin, DMax]]
[[DStDev, DStDevP]]
[[DSum]]
[[DVar, DVarP]]
!!!Example
<<tiddler "Dfunctions example">>
You can use the ~DLookup function to get the value of a particular field from a specified set of records (a domain).
You can use the ~DLookup function to display the value of a field that isn't in the record source for your form. For example, suppose you have a form based on an Order Details table. The form displays the ~OrderID, ~ProductID, ~UnitPrice, Quantity, and Discount fields. However, the ~ProductName field is in another table, the Products table. You could use the ~DLookup function in an event to display the ~ProductName on the same form.
!!!Syntax
{{{DLookup(expression, domain[, criteria][, orderclause])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DLookup function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the ~DLookup function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
|Orderclause | String |A string expression specifying the sequence of the returned records. It is a SQL ORDER BY clause without the words ORDER BY. It can include the ASC or DESC keywords. |
!!!Returned value
{{{Variant}}}
!!!Remarks
*All //expression//, //domain//, //criteria// and //orderclause// arguments may use database record- or fieldnames surrounded wit square brackets [].
*The ~DLookup function returns a single field value based on the information specified in //criteria//. If more than one record meet //domain// and //criteria//, the DLookup function returns a __random__ value in the domain. If a //orderclause// is present the ~DLookup function will return the __first__ value that meets the criteria.
*If no record satisfies //criteria// or if //domain// contains no records, the ~DLookup function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DAvg]]
[[DCount]]
[[DMin, DMax]]
[[DStDev, DStDevP]]
[[DSum]]
[[DVar, DVarP]]
!!!Example
<<tiddler "Dfunctions example">>
Note that the same logic applies to most Domain Aggregate Functions ([[DMin, DMax]] etc.)
!!!Normal usage
*For numerical values:
//{{{
DLookup("FieldName" , "TableName" , "Criteria=" & num)
//}}}
*For strings: (note the single quote before and after the value)
//{{{
DLookup("FieldName" , "TableName" , "Criteria='" & string & "'")
//}}}
*For dates: ISO notation => ''~YYYY-MM-DD''
//{{{
DLookup("FieldName" , "TableName" , "Criteria='" & Format(date, "YYYY-MM-DD") & "'")
//}}}
!!!Refering to a form control
*For numerical values
//{{{
DLookup("FieldName", "TableName", "Criteria=" & getValue("Forms!FormName!ControlName")
//}}}
*For strings: (note the single quote before and after the value)
//{{{
DLookup("FieldName", "TableName", "Criteria='" & getValue("Forms!FormName!ControlName") & "'")
//}}}
*For dates:
//{{{
DLookup("FieldName", "TableName", "Criteria='" & Format(getValue("Forms!FormName!ControlName")) & "'")
//}}}
!!!~Mix-n-Match
//{{{
DLookup("FieldName", "TableName", "Criteria1=" & Forms!FormName!Control1 _
& " AND Criteria2='" & getValue(Forms!FormName!Control2) & "'" _
& " AND Criteria3='" & Format(getValue(Forms!FormName!Control3), "YYYY-MM-DD") & "'")
//}}}
You can use the ~DMin and ~DMax functions to determine the minimum and maximum values of a set of values in a specified set of records (a domain).
!!!Syntax
{{{DMin(expression, domain[, criteria])}}}
{{{DMax(expression, domain[, criteria])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DMin (~DMax) function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the ~DMin (~DMax) function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
!!!Returned value
{{{Variant}}}
!!!Remarks
*All //expression//, //domain// and //criteria// arguments may use database record- or fieldnames surrounded wit square brackets [].
*If no record satisfies //criteria// or if //domain// contains no records, the ~DMin (~DMax) function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DAvg]]
[[DCount]]
[[DLookup]]
[[DStDev, DStDevP]]
[[DSum]]
[[DVar, DVarP]]
!!!Example
<<tiddler "Dfunctions example">>
You can use the ~DStDev and ~DStDevP functions to determine the standard deviation of a set of values in a specified set of records (a domain).
!!!Syntax
{{{DStDev(expression, domain[, criteria])}}}
{{{DStDevP(expression, domain[, criteria])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DStDev (~DStDevP) function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the ~DStDev (~DStDevP) function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
!!!Returned value
{{{Variant}}}
!!!Remarks
*All //expression//, //domain// and //criteria// arguments may use database record- or fieldnames surrounded wit square brackets [].
*If no record satisfies //criteria// or if //domain// contains no records, the ~DStDev (~DStDevP) function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DAvg]]
[[DCount]]
[[DLookup]]
[[DMin, DMax]]
[[DSum]]
[[DVar, DVarP]]
!!!Example
<<tiddler "Dfunctions example">>
You can use the ~DSum function to determine the sum of a set of numeric values in a specified set of records (a domain).
!!!Syntax
{{{DSum(expression, domain[, criteria])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DSum function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the ~DSum function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
!!!Returned value
{{{Variant}}}
!!!Remarks
*All //expression//, //domain// and //criteria// arguments may use database record- or fieldnames surrounded wit square brackets [].
*If no record satisfies //criteria// or if //domain// contains no records, the ~DSum function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DAvg]]
[[DCount]]
[[DLookup]]
[[DMin, DMax]]
[[DStDev, DStDevP]]
[[DVar, DVarP]]
!!!Example
<<tiddler "Dfunctions example">>
You can use the ~DVar and ~DVarP functions to determine the variance of a set of values in a specified set of records (a domain).
!!!Syntax
{{{DVar(expression, domain[, criteria])}}}
{{{DVarP(expression, domain[, criteria])}}}
!!!Arguments
| !Argument | !Type |!Description |
|Expression | String |An expression that identifies the field whose value you want to return. It can be a string expression identifying a field in a table or query, or it can be a SQL expression that performs a calculation on data in that field. However the SQL expression must not include any SQL aggregate function. |
|Domain | String |A string expression identifying the set of records that constitutes the domain. It can be a table name or a query name for a query that does not require a parameter. |
|Criteria | String |An optional string expression used to restrict the range of data on which the ~DVar (~DVarP) function is performed. For example, criteria is often equivalent to the WHERE clause in an SQL expression, without the word WHERE. If criteria is omitted, the ~DVar (~DVarP) function evaluates expr against the entire domain. Any field that is included in criteria must also be a field in domain. |
!!!Returned value
{{{Variant}}}
!!!Remarks
*All //expression//, //domain// and //criteria// arguments may use database record- or fieldnames surrounded wit square brackets [].
*If no record satisfies //criteria// or if //domain// contains no records, the ~DVar (~DVarP) function returns a ''Null''.
*Construct the //criteria// argument carefully to ensure that it will be evaluated correctly as a valid WHERE clause.
!!!Error messages
|~DFunction execution failed SQL='...' |
!!!See also
[[DAvg]]
[[DCount]]
[[DLookup]]
[[DMin, DMax]]
[[DStDev, DStDevP]]
[[DSum]]
!!!Example
<<tiddler "Dfunctions example">>
{{firstletter{
@@color:#930;A@@
}}} //Database// [[object|Object Model]] describes the database the application is currently connected to.
!!!Functions returning a database object
| !Function | !Type | !Argument |!Description |
|[[CurrentDb]] | Method | none |{{{CurrentDb()}}} returns an object corresponding with the current database. |
!!!Properties
| !Property | !Type | !Read only | !Description or UNO object |
|[[ObjectType]] || Y |Returns "DATABASE" |
|Document | UNO | Y |com.sun.star.comp.dba.~ODatabaseDocument |
|Connection | UNO | Y |com.sun.star.sdbc.drivers.~OConnectionWrapper |
|~MetaData | UNO | Y |interface ~XDatabaseMetaData |
!!!Methods
None
!!!See also
[[CurrentDb]]
!!!Remarks
The Database object has no real usage in the frame of ~Access2Base. Except if the developer wants to access its UNO properties.
(Q) Can I hide the database window ?
(R) No, the database window cannot be hidden. It can however be minimized.
What is called here the //database window// is the screen welcoming the user when (s)he opens a database front-end file (suffixed with ".odb") where the tables, queries, forms and reports are listed.
It can be desirable to hide that window and, instead, opening a form for example.
!!!Minimize the database window
Very easy code but it's as easy for the user to restore it with a mouse click. Nevertheless ... first select the //database window// then minimize it.
//{{{
Const acDatabaseWindow = 102
SelectObject(acDatabaseWindow)
Minimize()
//}}}
A variant:
//{{{
Const acDatabaseWindow = 102
SelectObject(acDatabaseWindow)
MoveSize ,,10,10
//}}}
!!!See also
[[SelectObject]]
[[Minimize]]
[[Maximize]]
[[MoveSize]]
!!!Role
Registers in the Traces circular buffer a new entry. The arguments will be presented in tabular form.
!!!Syntax
{{{DebugPrint([Value1[, Value2[, Value3[ ... ])}}}
!!!Arguments
| !Arguments | !Type | !Default | !When ... | !Result string |
|List of values separated by commas | Any | Empty string ("") | Empty<br />Object<br />Null<br />Variant<br />Array<br />Boolean<br />Numeric<br />Date<br />String<br />Other |{{{--EMPTY--}}}<br />[~Object-Type] ~Object-Name<br />{{{--NULL--}}}<br />{{{--VARIANT--}}}<br />{{{--ARRAY--}}}<br />True or False<br />The numeric value<br />The Date value<br />The string<br />(ERROR) |
!!!See also
[[Error Handler]]
[[TraceConsole]]
[[TraceError]]
[[TraceLog]]
!!!Example
<<tiddler "DebugPrint example">>
Display debug information.
Next code ...
//{{{
Dim oForm As Object, sString As String, dDate As Date
Set oForm = AllForms("myForm")
sString = "a string"
dDate = DateSerial(2012,5,10)
DebugPrint dDate, sString, oForm, oForm.Name, oForm.IsLoaded
//}}}
... generates next entry in the console:
//{{{
15:08:31 ===> 10/05/2012 a string [FORM] myForm myForm False
//}}}
You can use the Default property to specify whether a command button is the default button on a form.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |~CommandButton | None |A control on an open form |
!!!Syntax
//control//{{{.Default}}}
//control//{{{.Default = }}}//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property 'Default' not applicable in this context |
|Value '...' is invalid for property 'Default' |
!!!See also
[[Cancel]]
!!!Example
<<tiddler "Cancel & Default example">>
The //~DefaultValue// property specifies a value that is automatically entered in a field when a new record is created.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |~CheckBox<br />[[ComboBox]]<br />~CommandButton<br />~CurrencyField<br />~DateField<br />~FileControl<br />~FormattedField<br />[[ListBox]]<br />~NumericField<br />~PatternField<br />[[RadioButton]]<br />~SpinButton<br />~TextField<br />~TimeField | All |A control on an open form |
!!!Syntax
//control//{{{.DefaultValue}}}
//control//{{{.DefaultValue = }}}//value//
!!!Returned values / Arguments
{{{Variant}}}
!!!Remarks
!!!Error messages
|Property '~DefaultValue' not applicable in this context |
|Value '...' is invalid for property '~DefaultValue' |
!!!Example
<<tiddler "DefaultValue example">>
List the default value of all controls - if relevant - on an open form
//{{{
Dim ofForm As Object, ocControl As Object, i As Integer, iCount As Integer
Set ofForm = Forms("myForm")
iCount = ofForm.Controls.Count
For i = 0 To iCount - 1
Set ocControl = ofForm.Controls(i)
If hasProperty(ocControl, "DefaultValue") Then Print ocControl.Name & "=" & ocControl.DefaultValue
Next i
Print
//}}}
Database functions
//{{{
Dim sLabel As String, sKey As String, sCategory As String
Dim dblAverage As Double, iCount As Integer, dblSum As Double
Dim dblMin As Double, dblMax As Double
Dim dblStdev As Double, dblStdevP As Double, dblVar As Double, dblVarP As Double
sKey = "27165"
sLabel = DLookup("[DESCRIPTION]", "[PRODUCTS]", "[PRODUCT CODE]='" & sKey & "'") ' SQL expects single quotes
sCategory = "METALLIC"
dblAverage = DAvg("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
iCount = DCount("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
dblSum = DSum("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
' dblAverage should be = dblSum/iCount !!!
dblMin = DMin("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
dblMax= DMax("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
dblStdev = DStdev("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
dblStdevP = DStdevP("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
dblVar = DVar("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
dblVarP = DVarP("[SALES PRICE]", "[PRODUCTS]", "[CATEGORY]='" & sCategory & "' AND [SALES PRICE]>0")
' Sqr(dblVar) should be = dblStdev !!!
//}}}
!!Download //~Access2Base// either from the
*[[OpenOffice extensions repository|http://extensions.services.openoffice.org/en/project/access2base]]
*[[LibreOffice extensions center|http://extensions.libreoffice.org/extension-center/access2base]]
The downloaded contents are identical if their version numbers are identical too.
!!Install the //~Access2Base// extension
The name of he downloaded file is __~Access2Base.oxt__. Select preferably the last proposed version.
Note: //some browsers might download the extension as a .zip file; if this happens rename the downloaded file from .zip to .oxt//
Install the extension as any other extension. To know more, follow the instructions in "[[Installing an extension|http://extensions.services.openoffice.org/en/resources/user/howto_install]]" or download next [[PDF file|http://www.libreoffice.org/assets/Uploads/EN_Documents/Installingextensions.pdf]]
!!Use the extension
To be able to invoke the //~Access2Base// API from a AOO/~LibO ".odb" file (the usual suffix for the front-end part of database documents) you have to
*Have a minimal knowledge of the Basic IDE.
*Open the concerned ".odb" file (the database document) in the main AOO/~LibO Base window.
*With {{{Tools + Macros + Organize Macros + OpenOffice[LibreOffice] Basic...}}} open the Basic IDE and create a Basic module in the Standard library of the database document. The module should contain as a minimum next code:
<<tiddler "Openconnection example">>
*Assign in the main Base window with menu items {{{Tools + Customize...}}} ({{{Events}}} tab) the above Sub ("~DBOpen" in the example but use the name of your choice) to the //~OpenDocument// event. Save in the ".odb" file itself.
*//Close// and re-//open// the ".odb" file. This will trigger the //~OpenDocument// event.
*Start programming macro's. Associate them with //form// or //control events// if relevant.
Caution: the procedure is different for [[Standalone Forms]].
!!The Basic IDE ...
... has now 2 more options:
#The {{{Tools + Add-Ons + Access2Base Console ...}}} menu item opens the ~Access2Base console (see the [[Error Handler]]).
#The {{{Help + Access2Base Online Help}}} menu item opens the current Help file in your preferred browser.
!!See also
[[OpenConnection]]
[[Standalone Forms]]
!!Software exposure
Before releasing a new version of the ~Access2Base API a battery of non-regression tests is run automatically on next environments:
| !Software | !Version | !Operating System |
|~LibreOffice | 3.6 |Linux Ubuntu 12.10 |
|~OpenOffice | 3.4 |Windows 7 |
|~OpenOffice | 3.3 |Windows 7 |
|~OpenOffice | 3.4 |Windows Vista |
|~LibreOffice<br />(Portable version) | 3.6 |Windows 7 |
!!Releases History
<<tiddler "ReleaseNotes">>
*Employees table
| !Fields | !Field Type | !Primary |
|Address | Text ||
|~BirthDate | Date/Time ||
|City | Text ||
|Country | Text ||
|Extension | text ||
|~FirstName | text ||
|~HireDate | Date/Time ||
|~HomePhone | Text ||
|~LastName | Text ||
|Notes | Text ||
|Photo | Text ||
|~PostalCode | Text ||
|Region | Text ||
|~ReportsTo | ~BigInt ||
|Title | Text ||
|~TitleOfCourtesy | Text ||
|~EmployeeID | ~BigInt | Y |
The //Enabled// property specifies if the control is accessible with the cursor.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />[[SubForm]]-- | All |A control on an open form |
!!!Syntax
//control//{{{.Enabled}}}
//control//{{{.Enabled = }}}//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property 'Enabled' not applicable in this context |
|Value '...' is invalid for property 'Enabled' |
!!!See also
[[Locked]]
!!!Example
<<tiddler "Enabled & Locked example">>
Lock and disable control
//{{{
Dim ocControl As Object
Set ocControl = Controls("myForm", "myControl")
ocControl.Enabled = False
ocControl.Locked = True
//}}}
(Q) How can I cycle through the controls on a form and retrieve their names?
(R) Use the following function as an example. Pass the form's name to it and watch the displayed result.
Note: Make sure you also copy [[fIsLoaded|FindOutFormOpen]] function since fEnumControls uses it internally to make sure that the form to be enumerated is open.
//{{{
Sub fEnumControls(ByVal sFrmToEnum As String)
'Display control's Type and Name
'will NOT enumerate controls within an embedded subform
'if form is closed, exit function
Const vbCritical = 16
If Not fIsLoaded(sFrmToEnum) Then
MsgBox "Form " & sFrmToEnum & " is probably closed!! " & _
"Please open it & try again.", vbCritical
Exit Sub
End If
Dim oForm As Object, oControl As Object, iCount As Integer, i As Integer
Set oForm = Forms(sFrmToEnum)
'Count the number of controls
iCount = oForm.Controls().Count
For i = 0 To iCount - 1
Set oControl = oForm.Controls(i)
DebugPrint oControl.SubType & ":", oControl.Name
Next i
End Sub
//}}}
!!!See also
[[Forms]]
[[Controls]]
[[Count]]
[[Name]]
[[SubType]]
[[DebugPrint]]
!!!Introduction
~Access2Base uses internally an error handler that can be optionally used by users in their own code.
The principles are:
*An error has an __error-level__. The error-level determines the severity of the error and the behaviour of the program after the error trap: stop or go ahead ?
*All errors, whatever their level, can be registered on the request of the programmer. The technique used by ~Access2Base is to keep the error //traces// in memory through a //circular buffer//, i.e. a buffer where the oldest entries are replaced by the new ones when the buffer gets full.
*The error traces (circular buffer) can be viewed for debugging purposes.
*All the user-defined Subs or Functions follow the same code structure for error handling.
!!!To view the errors log
Use the
>{{{Tools + Add-Ons + Access2Base Console ...}}}
menu action in the Basic IDE.
!!!API
The routines for error handling are:
|TraceConsole |Open a dialog box for display of all past errors and logs. |
|TraceError |Report an error found. |
|TraceLog |Log an event in the circular buffer if its level is at least equal to the minimal error level. |
|DebugPrint |Record as many values as wanted in tabular form in the circular buffer, typically for debugging. |
!!!Error levels
| !Level | !Description |
|DEBUG |To report values of variables during the program execution. The report is NOT user visible. |
|INFO |To report any event |
|WARNING |To report some abnormal event. |
|ERROR |To report an error trapped by a user program. |
|FATAL |To report an error detected by ~Access2Base (f.i. "Form does not exist ..." etc.). |
|ABORT |To report an error inside the ~Access2Base API itself. Do not use for programmer or user errors. |
!!!Recommended program structure for error handling
The example is given for a //Sub//. It is, mutatis mutandis, equally valid for a //Function//.
//{{{
Sub mySub
On Local Error Goto Error_Sub
...
Exit_Sub:
Exit Sub
Error_Sub:
TraceError("ERROR", Err, "MySub", Erl)
Goto Exit_Sub
End Sub
//}}}
In case of error next message will be displayed to the user and simultaneously registered in the trace buffer:
>Error # //number// (//...description...//) occurred at line //line// in mySub.
The {{{Event}}} [[object|Object Model]] describes an event occurred in a form or a form control.
!!!Functions returning an //Event// object
| !Function | !Type | !Arguments |!Description |
|[[Events]] | [[Collection]] | the //event// object passed by ~OpenOffice/~LibreOffice<br />as argument of a document, form, subform or control event |{{{Events(oEvent)}}} returns an //Event// object. |
!!!Properties of an //Event// object
| !Property | !Type | !Description |
|~EventType | String |See the [[events handler|Events Handler]]. |
|~EventName | String |The following //~EventNames// are usually available:<br />//~OnAlphaCharInput, ~OnClick, ~OnCloseApp, ~OnCopyTo, ~OnCopyToDone, ~OnCreate, ~OnError, ~OnFocus, ~OnInsertDone, ~OnInsertStart, ~OnLoad, ~OnLoadCancel, ~OnLoadDone, ~OnLoadError, ~OnLoadFinished, ~OnMailMerge, ~OnMailMergeFinished, ~OnModifyChanged, ~OnMouseOut, ~OnMouseOver, ~OnMove, ~OnNew, ~OnNewMail, ~OnNonAlphaCharInput, ~OnPageCountChange, ~OnPrepareUnload, ~OnPrepareViewClosing, ~OnPrint, ~OnResize, ~OnSave, ~OnSaveAs, ~OnSaveAsDone, ~OnSaveDone, ~OnSaveFinished, ~OnSelect, ~OnStartApp, ~OnSubComponentClosed, ~OnSubComponentOpened, ~OnTitleChanged, ~OnToggleFullscreen, ~OnUnfocus, ~OnUnload, ~OnViewClosed, ~OnViewCreated.// |
|~ContextShortcut | String |The [[shortcut notation|ShortCut Notation]] of the object (form or control) having triggered the event. |
|~ButtonLeft<br />~ButtonRight<br />~ButtonMiddle | Boolean |Indicates if the mouse button has been pressed .|
|~XPos<br />~YPos | Null or Long |Coordinates of the mouse cursor. |
|~ClickCount | Long |Number of mouse clicks. |
|~KeyCode | Integer |See the constants group com.sun.star.awt.Key |
|~KeyChar | String |The pressed key. |
|~KeyFunction | Integer |See the constants group com.sun.star.awt.~KeyFunction |
|~KeyAlt<br />~KeyCtrl<br />~KeyShift | Boolean |Key combined with Alt, Ctrl or Shift keys. |
|~FocusChangeTemporary | Boolean |False if focus change due to a user action in same window. |
|[[ObjectType]] | String |Returns "EVENT" |
|~RowChangeAction | Long |See the constants group com.sun.star.sdb.~RowChangeAction |
|Recommendation | String |"IGNORE" if the event is recommended to be ignored. Valid only for the //Before record action// form event which is, for strange reasons, fired twice. The first time is recommended to be ignored. |
|Source | Object |Return the [[Database]], [[Form]], [[SubForm]] or [[Control]] object having fired the event |
|~SubComponentName | String |The name of the component being //opened// or //closed// while executing a //Loaded a sub component// or //Closed a sub component// event. Such an event is set thru the {{{Tools + Customize ... + Events}}} menu command. |
|~SubComponentType | Long |To be associated with the //~SubComponentName// property. Returns one of next constants:<br />//acTable// (0)<br />//acQuery// (1)<br />//acForm// (2)<br />//acReport// (3). |
!!!Remarks
*All properties are read-only.
*Their values are accessible with the usual syntax:<br /> <br />//oEvent//{{{.property}}}
!!!See also
[[Events Handler]]
[[Events]]
!!!Example
<<tiddler "Event example">>
Assign next macro to the //~TextModified// event of a combo box (other controls could require that the //Changed// event should be used for the same purpose).
When the user changes his/her selection in the combo box the content of the form is requeried and refreshed on the screen.
//{{{
Sub SelectChanged(poEvent As Object)
REM Combo value has changed
REM => requery form
Dim oeEvent As Object, ocCombo As Object, sSQL As String, oForm As Object
Set oeEvent = Events(poEvent)
Set ocCombo = oeEvent.Source
sSQL = "SELECT [PRODUCT CODE],[DENOMINATION],[SUPPLIER ID] FROM PRODUCTS WHERE " _
& "[SUPPLIER ID]='" & ocCombo.Value & "'"
Set oForm = Forms("myComboForm")
oForm.RecordSource = sSQL
End Sub
//}}}
The {{{Events}}} collection returns the (unique) instance of the currently executed [[event object|Event]].
!!!Syntax
{{{Events(}}}//event//{{{)}}}
The //event// argument is the variable of {{{Object}}} type given as argument by ~OpenOffice/~LibreOffice to the macro invoked when the event occurs.
!!!Returned values
Either
- a {{{Null}}} value - the event is not really an event or it was triggered by an unsupported event type - or some other error occurred (the call to {{{Events()}}} never stops the execution of the macro).
or
- an object of type //Event//.
!!!See also
[[Events Handler]]
[[Event]]
!!!Example
<<tiddler "Event example">>
{{firstletter{
@@color:#930;E@@
}}}''vents'' can automatically execute a macro when a specified software event occurs by assigning the desired macro to the event. The macros might be defined at database document, [[form|Form]], [[subform|SubForm]] or [[control|Control]] level. The triggered macro has one argument of type //Object//.
The //Events Handler// of //~Access2Base// provides a mean to standardize the processing of events and to increase the reusability of macros: indeed the same macro could be used for several controls - if meaningful, of course - if, as an example, there is an easy way to identify the control which triggered the macro.
''Note that the described technique has nothing in common with the events processing in //~MSAccess//.''
!!!Step by step
#Assign the event to a macro: see the ~OpenOffice/~LibreOffice Help or documentation.
#In the code of the macro invoke the [[Events]] collection. Note that the macro may be a {{{Sub}}} or a {{{Function}}} depending on the necessity or not to return the value {{{False}}} to cancel the event.
#Use the properties of the returned object to process the event. In particular the //Source// property.
//{{{
Sub myEventMacro(poEvent As Object)
Dim oeEvent As Object, myControl As Object
Set oeEvent = Events(poEvent)
Set myControl = oEvent.Source ' Return the Control object
' that triggered the event
REM ...
End Sub
//}}}
!!!Event types
The types of events supported by the ~Access2Base API are listed below. See the ~OpenOffice/~LibreOffice documentation for more details.
The invocation of {{{Events()}}} returns a {{{Null}}} value when other event types occur.
| !Event type | !Description |
|DOCUMENTEVENT |At document (database) level. |
|EVENTOBJECT |Generic for most //form// and //control// events. |
|ACTIONEVENT |Triggered by a button, ... |
|FOCUSEVENT |Triggered by a focus change. |
|INPUTEVENT |Use of special keys. |
|ITEMEVENT |Action in menu or listbox. |
|KEYEVENT |Use of normal keys. |
|MOUSEEVENT |Mouse move or click. |
|ROWCHANGEEVENT |Insert, update or delete action. |
|TEXTEVENT |Edition of //control// content. |
!!!See also
[[Events]]
[[Event]]
[[getObject]]
!!!Example
<<tiddler "Event example">>
(Q) Is it possible to have some fields filled in automatically as soon as a certain value has been entered into another field?
(R) A typical example of this is getting state and city name from Zipcodes. If you have a ~Zip-Code table, you'll never have to enter the State/City again.
It is illustrated using next //Employees// table:
<<tiddler "EmployeesTable">>
Assume a form with a number of read-only fields corresponding with that table although __the form is not bound to the table__, then trigger next code in the //When losing focus// event of an editable field in which an employee id might be entered:
//{{{
Sub EmpFillAuto(poEvent As Object)
Dim oEvent As Object, oEmpID As Object, sCrit As String
Dim oParentForm As Object, oField As Object
Set oEvent = Events(poEvent)
oEmpID = oEvent.Source
sCrit = "[EmployeeID]=" & oEmpID.Value
Set oParentForm = oEmpID.Parent
With oParentForm
Set oField = .Controls("txtTitleOfCourtesy")
oField.Value = DLookup("[TitleOfCourtesy]", "[Employees]", sCrit)
Set oField = .Controls("txtFirstName")
oField.Value = DLookup("[FirstName]", "[Employees]", sCrit)
Set oField = .Controls("txtLastName")
oField.Value = DLookup("[LastName]", "[Employees]", sCrit)
Set oField = .Controls("txtAddress")
oField.Value = DLookup("[Address]", "[Employees]", sCrit)
Set oField = .Controls("txtCity")
oField.Value = DLookup("[City]", "[Employees]", sCrit)
End With
End Sub
//}}}
!!!See also
[[Controls]]
[[DLookup]]
[[Events Handler]]
You can use the //Filter// property to specify a subset of records to be displayed when a filter is applied to a form.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
|[[SubForm]] |A subform in an open form |
!!!Syntax
//form//{{{.Filter}}}
//form//{{{.Filter = }}}//value//
//subform//{{{.Filter}}}
//subform//{{{.Filter = }}}//value//
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
The //Filter// property is a string expression consisting of a ''WHERE'' clause without the WHERE keyword. Like in //~MsAccess// __table names__, or __field names__ (e.g. when containing a space) may be surrounded by square brackets ([]).
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property 'Filter' |
!!!See also
[[FilterOn]]
!!!Example
<<tiddler "Filter example">>
Set and apply a filter on a form
//{{{
Dim ofForm As Object, sFilter As String
Set ofForm = Forms("myForm")
sFilter = "[VAT CODE]=3 And [PRODUCT CODE]<'28000'"
ofForm.Filter = sFilter
ofForm.FilterOn = True
//}}}
Use the //~FilterOn// property to specify or determine whether the Filter property for a form is applied.
!!!Applies to ...
| !Object | !Type |!Description |
|[[Form]] ||An open form |
|[[SubForm]] ||A subform in an open form |
!!!Syntax
//form//{{{.FilterOn}}}
//form//{{{.FilterOn = }}}//value//
//subform//{{{.FilterOn}}}
//subform//{{{.FilterOn = }}}//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property '~FilterOn' |
!!!See also
[[Filter]]
!!!Example
<<tiddler "Filter example">>
{{firstletter{
@@color:#930;T@@
}}}he //~FindNext// [[action|Actions]] finds the next instance of data that meets the criteria specified by the arguments of the last invoked [[FindRecord]] action.
If a match has been found, the cursor is set in the matching field. Otherwise it returns to the starting record.
The starting record is NOT the record where the focus is on but the last record reached by the previous //~FindRecord// action.
!!!Syntax
{{{FindNext()}}}
!!!Remarks
*A previous //~FindRecord// action is mandatory. Otherwise the invocation of //~FindNext// will generate an error.
*//~FindNext// returns //True// if a matching occurrence has been found.
!!!Error messages
|~FindNext() must be preceded by a successful ~FindRecord(...) call |
!!!See also
[[FindRecord]]
!!!Example
<<tiddler "FindRecord example">>
(Q) How do I find out from code if a form is open or not?
(R) Pass the form name to the following function. Function will return True if form is open and False if it's not.
//{{{
Function fIsLoaded(ByVal sFormName As String) As Boolean
' sFormName is not case sensitive
fIsLoaded = AllForms(sFormName).IsLoaded
End Function
//}}}
!!!See also
[[AllForms]]
[[IsLoaded]]
{{firstletter{
@@color:#930;T@@
}}}he //~FindRecord// [[action|Actions]] finds the first instance of data that meets the criteria specified by the //~FindRecord// arguments. This can be in a succeeding or prior record, or in the first record. The search is done in a single column or in all columns of a __form__ (or __subform__)'s [[GridControl]].
If a match has been found, the cursor is set in the matching field.
!!!Syntax
{{{FindRecord(FindWhat,}}}//{{{ Match, MatchCase, Search, SearchAsFormatted, OnlyCurrentField, FindFirst}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{FindWhat}}} | No | String<br />Date<br />Number |Specifies the data you want to find in the record. Enter the text, number, or date you want to find. |
|{{{Match}}} | Yes | acAnyWhere<br />acEntire<br />acStart |Specifies where the data is located in the field. You can specify a search for data in any part of the field (acAnyWhere), for data that fills the entire field (acEntire), or for data located at the beginning of the field (acStart). The default is acEntire. |
|{{{MatchCase}}} |~| Boolean |Specifies whether the search is case-sensitive (uppercase and lowercase letters must match exactly). The default is False. |
|{{{Search}}} |~| acDown<br />acSearchAll<br />acUp |Specifies whether the search proceeds from the current record up to the beginning of the records (acUp); down to the end of the records (acDown); or down to the end of the records and then from the beginning of the records to the current record, so all records are searched (acSearchAll). The default is acSearchAll. |
|{{{SearchAsFormatted}}} |~| Boolean |If present, must be FALSE. True is not supported. |
|{{{OnlyCurrentField}}} |~| acAll<br />acCurrent |Specifies whether the search is confined to the current field in each record (acCurrent) or includes all fields in each record (acAll). The default is acCurrent. |
|~|~| String |The argument must contain a [[shortcut|ShortCut Notation]] to a GridControl or to a column of a [[GridControl]]. If the shortcut points to a ~GridControl all the columns are scanned to find a match. |
|{{{FindFirst}}} |~| Boolean |Specifies whether the search starts at the first or last record (depending on the //Search// argument) or at the current record. The default is True. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acAnywhere = 0
Global Const acEntire = 1
Global Const acStart = 2
Global Const acDown = 1
Global Const acSearchAll = 2
Global Const acUp = 0
Global Const acAll = 0
Global Const acCurrent = -1
//}}}
!!!Remarks
*The //~FindRecord// action is most often started from an event. Clicking on a button in a form triggering the event might change the focus from the current field to the button which is not the desired effect. In that case use the [[setFocus]] method, either on the //form// or on the targeted //control//, before executing the //~FindRecord// statement.
*The targeted //form// or //subform// MUST contain a //gridcontrol//.
*The //~FindRecord// action is a function. It returns //True// if a match ha been found, and //False// otherwise.
*Using a shortcut (i.e. a string ...) as {{{OnlyCurrentField}}} argument is the __only__ way to run a //~FindRecord// action in a //~GridControl// belonging to a //~SubForm//.
!!!Error messages
|No active form or control found |
|Form '...' has no underlying dataset |
|Control '...' not found in gridcontrol '...' |
|No gridcontrol found in form '...' |
!!!See also
[[FindNext]]
[[setFocus]]
!!!Example
<<tiddler "FindRecord example">>
Find the record starting from the top having the value "3" in one of the numeric columns:
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
ofForm.setFocus
If Not FindRecord(3, , , , , acAll) Then MsgBox "Not Found !"
//}}}
Next statement will retrieve the next occurrence:
//{{{
FindNext() ' Parentheses are optional
//}}}
Change control aspect
//{{{
Dim ofForm As Object, ocControl As Object
Set ofForm = Forms("myForm")
Set ocControl =ofForm.Controls("myControl")
If ofForm.Controls("myChkBox").Value = 1 Then
ocControl.FontName = "Verdana"
ocControl.FontSize = 18
ocControl.FontBold = True
ocControl.FontItalic = True
ocControl.FontUnderline = True
ocControl.ForeColor = RGB(255, 0, 0
ocControl.TextAlign = 2
End If
//}}}
... or alternatively ...
//{{{
Dim ofForm As Object, ocControl As Object
Set ofForm = Forms("myForm")
Set ocControl =ofForm.Controls("myControl")
If ofForm.Controls("myChkBox").Value = 1 Then
ocControl.FontName = "Verdana"
ocControl.FontSize = 18
ocControl.FontWeight = com.sun.star.awt.FontWeight.ULTRABOLD ' alternative to Bold property
ocControl.FontItalic = True
ocControl.FontUnderline = True
ocControl.ForeColor = RGB(255, 0, 0
ocControl.TextAlign = 2
End If
//}}}
The //~FontBold// property specifies whether a font appears in a bold style in a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.FontBold}}}
//control//{{{.FontBold = }}}//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property '~FontBold' not applicable in this context |
|Value '...' is invalid for property '~FontBold' |
!!!See also
[[FontItalic]]
[[FontName]]
[[FontSize]]
[[FontUnderline]]
[[FontWeight]]
[[ForeColor]]
[[TextAlign]]
!!!Example
<<tiddler "Font example">>
The //~FontItalic// property specifies whether text appears in italic in a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.FontItalic}}}
//control//{{{.FontItalic = }}}//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property '~FontItalic' not applicable in this context |
|Value '...' is invalid for property '~FontItalic' |
!!!See also
[[FontBold]]
[[FontName]]
[[FontSize]]
[[FontUnderline]]
[[FontWeight]]
[[ForeColor]]
[[TextAlign]]
!!!Example
<<tiddler "Font example">>
The //~FontName// property specifies the name of the font used to display a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.FontName}}}
//control//{{{.FontName = }}}//value//
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
!!!Error messages
|Property '~FontName' not applicable in this context |
|Value '...' is invalid for property '~FontName' |
!!!See also
[[FontBold]]
[[FontItalic]]
[[FontSize]]
[[FontUnderline]]
[[FontWeight]]
[[ForeColor]]
[[TextAlign]]
!!!Example
<<tiddler "Font example">>
The //~FontSize// property specifies the size of the font used to display a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.FontSize}}}
//control//{{{.FontSize = }}}//value//
!!!Returned values / Arguments
{{{Integer}}} or {{{Long}}}
!!!Remarks
!!!Error messages
|Property '~FontSize' not applicable in this context |
|Value '...' is invalid for property '~FontSize' |
!!!See also
[[FontBold]]
[[FontItalic]]
[[FontName]]
[[FontUnderline]]
[[FontWeight]]
[[ForeColor]]
[[TextAlign]]
!!!Example
<<tiddler "Font example">>
The //~FontUnderline// property specifies whether text is underlined in a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.FontUnderline}}}
//control//{{{.FontUnderline = }}}//value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property '~FontUnderline' not applicable in this context |
|Value '...' is invalid for property '~FontUnderline' |
!!!See also
[[FontBold]]
[[FontItalic]]
[[FontName]]
[[FontSize]]
[[FontWeight]]
[[ForeColor]]
[[TextAlign]]
!!!Example
<<tiddler "Font example">>
The //~FontWeight// property specifies the line width used to display characters in a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.FontWeight}}}
//control//{{{.FontWeight = }}}//value//
!!!Returned values / Arguments
{{{Integer}}} or {{{Long}}}
!!!Remarks
Allowed values for ~FontWeight are:
| Symbolic name || Numeric value |
|com.sun.star.awt.~FontWeight.DONTKNOW |The font weight is not specified/known. | 0 |
|com.sun.star.awt.~FontWeight.THIN |specifies a 50% font weight. | 50 |
|com.sun.star.awt.~FontWeight.ULTRALIGHT |specifies a 60% font weight. | 60 |
|com.sun.star.awt.~FontWeight.LIGHT |specifies a 75% font weight. | 75 |
|com.sun.star.awt.~FontWeight.SEMILIGHT |specifies a 90% font weight. | 90 |
|com.sun.star.awt.~FontWeight.NORMAL |specifies a normal font weight. | 100 |
|com.sun.star.awt.~FontWeight.SEMIBOLD |specifies a 110% font weight. | 110 |
|com.sun.star.awt.~FontWeight.BOLD |specifies a 150% font weight. | 150 |
|com.sun.star.awt.~FontWeight.ULTRABOLD |specifies a 175% font weight. | 175 |
|com.sun.star.awt.~FontWeight.BLACK |specifies a 200% font weight.| 200 |
!!!Error messages
|Property '~FontWeight' not applicable in this context |
|Value '...' is invalid for property '~FontWeight' |
!!!See also
[[FontBold]]
[[FontItalic]]
[[FontName]]
[[FontSize]]
[[FontUnderline]]
[[ForeColor]]
[[TextAlign]]
!!!Example
<<tiddler "Font example">>
The //~ForeColor// property specifies or determines the color (RGB) of the text in a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~HiddenControl<br />~ImageButton<br />~ImageControl<br />~ScrollBar<br />~SpinButton<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.ForeColor}}}
//control//{{{.ForeColor = }}}//value//
!!!Returned values / Arguments
{{{Long}}}
!!!Remarks
!!!Error messages
|Property '~ForeColor' not applicable in this context |
|Value '...' is invalid for property '~ForeColor' |
!!!See also
[[BackColor]]
[[BorderColor]]
[[BorderStyle]]
[[FontBold]]
[[FontItalic]]
[[FontName]]
[[FontSize]]
[[FontUnderline]]
[[FontWeight]]
[[TextAlign]]
!!!Example
<<tiddler "Color example">>
{{firstletter{
@@color:#930;A@@
}}} //Form// [object|Object Model]] describes one of the Forms located in the database document (".odb" file). The form can be either opened or closed.
If the property [[IsLoaded]] returns //True// then the form is opened.
!!!Functions returning a form object
| !Function | !Type | !Argument |!Description |
|[[AllForms]] | [[Collection]] | Integer or String |{{{AllForms("myForm")}}} returns an object corresponding with the {{{myForm}}} form |
|[[Forms]] | [[Collection]] | Integer or String |{{{Forms("myForm")}}} returns an object corresponding with the {{{myForm}}} form. {{{myForm}}} must be open. |
|[[getObject]] || String |{{{getObject("Forms!myForm")}}} returns an object corresponding with the {{{myForm}}} form. {{{myForm}}} must be open. |
!!!Properties
| !Property | !Type | !Read only | !Description or UNO object |
|[[Name]] || Y |Specifies the real name of the form |
|[[AllowAdditions]] |||Specifies whether a user can add a record when using the form. |
|[[AllowDeletions]] |||Specifies whether a user can delete a record when using the form. |
|[[AllowEdits]] |||Specifies whether a user can modify a record when using the form. |
|[[Caption]] |||Specifies the text that appears in the title bar. |
|[[Filter]] |||Specifies a subset of records to be displayed. |
|[[FilterOn]] |||Specifies if the Filter has to be applied. |
|[[Height]] |||Specifies the height of the form. |
|[[IsLoaded]] || Y |True if form is open. |
|[[ObjectType]] || Y |Returns "FORM" |
|[[OpenArgs]] || Y |Specifies the ~OpenArgs argument of an [[OpenForm]] action. |
|[[RecordSource]] |||Specifies the source of the data. |
|[[Visible]] |||Shows or hides the form. |
|[[Width]] |||Specifies the width of the form. |
|Component | UNO | Y |com.sun.star.text.~TextDocument |
|~ContainerWindow | UNO | Y ||
|~DatabaseForm | UNO | Y |com.sun.star.form.component.~DataForm<br />com.sun.star.sdb.~ResultSet |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[getProperty]] | property | Variant |Return the value of the given property. |
|[[hasProperty]] | property | Boolean |Return True if the Form has the given property. |
|[[Move]] | coordinates |~|Return True if Form has been moved successfully. |
|[[Refresh]] | None |~|Refresh data with its most recent value in the database. |
|[[Requery]] |~|~|Refresh the data displayed in the Form. |
|[[setFocus]] |~|~|Return True if focus set on Form successfully. |
|[[setProperty]] | value<br />property |~|Return True if the given property could be set. |
!!!Remarks
Each //Form// [[object|Object Model]] has a Controls [[collection|Collection]] method, which contains all controls on the form. You can refer to a specific control on a form by referring to the [[Controls]] collection.
!!!Examples
<<tiddler "Forms examples">>
The //Form// property refers to the //Form// associated with a [[subform control|SubForm]].
!!!Applies to ...
| !Pseudo object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | ~SubForm | None |A control on an open form representing a subset (subform) of the form |
!!!Syntax
//control//{{{.Form}}}
!!!Returned values
An [[object|Object Model]] of type {{{SubForm}}}
!!!Remarks
The //Form// property is read-only.
!!!Error messages
| Property 'Form' not applicable in this context |
!!!See also
The [[SubForm]] object
!!!Example
<<tiddler "Subform example">>
The //Format// property determines the way data is displayed in date or time fields.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | ~DateField<br />~FormattedField<br />~TimeField | ~DateField<br />~FormattedField<br />~TimeField |A control on an open form or within a [[GridControl]] of one of the listed types |
!!!Syntax
//control//{{{.Format}}}
!!!Returned values
{{{String}}}
!!!Remarks
The //Format// property is read-only.
!!!Error messages
|Property 'Format' not applicable in this context |
|Value '...' is invalid for property 'Format' |
!!!Examples
<<tiddler "Format example">>
Display the format of a formatted field
//{{{
Dim ocControl As Object
Set ocControl = Controls("myForm", "myFormattedField")
MsgBox ocControl.Format
//}}}
The //Forms// [[collection|Collection]] describes instances of all __open forms__ present in the database document (".odb" file).
!!!Syntax
{{{Forms()}}} or {{{Forms}}}
{{{Forms(index)}}}
{{{Forms(formname)}}}
{{{Forms(event)}}}
| !Argument #1 | !Type |!Returned value |
|| absent |A [[Collection]] object |
| index | integer<br>long |A [[Form]] object corresponding to the index-th item in the Forms() collection. The 1st form is Forms(0), the 2nd is Forms(1) and so on ... The last one is Forms.Count - 1.|
| formname | string |A [[Form]] object having the argument as name. The argument is NOT case-sensitive.|
| event | Object of //Event// class |A [[Form]] object having triggered the event. |
!!!Remarks
*~Access2Base does not support a hierarchy of form names although Base does it. Only single form names are allowed.
*You can refer to an individual Form object in the Forms collection either by referring to the form by name, or by referring to its index within the collection. If you want to refer to a specific form in the Forms collection, it's better to refer to the form by name because a form's collection index may change. The Forms collection is indexed beginning with zero. If you refer to a form by its index, the first form opened is Forms(0), the second form opened is Forms(1), and so on. If you opened Form1 and then opened Form2, Form2 would be referenced in the Forms collection by its index as Forms(1). If you then closed Form1, Form2 would be referenced in the Forms collection by its index as Forms(0).
*The //formname// argument is not case sensitive.
*The returned Form object is always a main form.
!!!Error messages
|Argument nr.1 is invalid |
|Out of array range or incorrect array size for collection Forms() |
|Form '...' not found |
|Form '...' is currently not open|
!!!See also ...
[[AllForms]]
!!!Examples
<<tiddler "Forms examples">>
To display the name of all open forms (uses the [[Name]] property):
//{{{
Dim i As Integer, oCollection As Object
Set oCollection = Forms
For i = 0 To oCollection.Count - 1 'Forms without argument returns a Collection object
Print Forms(i).Name, 'Forms(...) with an argument returns a Form object
Next i
Print
//}}}
Can shorter ... :
//{{{
Dim i As Integer
For i = 0 To Forms.Count - 1 'Forms without argument returns a Collection object
Print Forms(i).Name, 'Forms(...) with an argument returns a Form object
Next i
Print
//}}}
To know the size of an open form:
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
MsgBox "Height = " & ofForm.Height & ", Width = " & ofForm.Width
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //~GoToControl// [[action|Actions]] moves the focus to the named control in the active window. The active window is assumed to be a form.
!!!Syntax
{{{GoToControl(}}}//{{{ControlName}}}//{{{)}}}
| !Argument | !Optional | !Type |!Description |
|{{{ControlName}}} | No | String |The name of the control to move the focus to. This argument is NOT case-sensitive. |
!!!Remarks
*If the active window is not a form, or if the active window is indeed a form but no control is found with the given ~ControlName, or if such a control is found but it is not enabled, the ~GoToControl request is ignored.
*You can also use the [[setFocus]] method to move the focus to a control on a form or any of its subforms. This is the preferred method for moving the focus, especially to controls on subforms and nested subforms.
!!!Error messages
|Argument nr.1 is invalid |
!!!See also
[[setFocus]]
!!!Example
//{{{
SelectObject(acForm, "myForm")
GoToControl("myControl")
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //~GoToRecord// [[action|Actions]] makes the specified record the current record in an open form.
!!!Syntax
{{{GoToRecord(}}}//{{{ObjectType, ObjectName, Record, Offset}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{ObjectType}}} | Yes | acActiveDataObject<br />acDataForm |The type of object that contains the record you want to make current. Leave this argument blank to select the active form. |
|{{{ObjectName}}} |~| String |The name of the object that contains the record you want to make the current record. If you leave the Object Type argument blank, leave this argument blank also.<br />This argument may also contain a [[shortcut|ShortCut Notation]] to a [[Form]] or a [[SubForm]]. |
|{{{Record}}} |~| acFirst<br />acGoTo<br />acLast<br />acNewRec<br />acNext<br/>acPrevious |Specifies the record to make the current record The default is //acNext//. |
|{{{Offset}}} |~| Integer<br />Long |This argument specifies the record to make the current record. You can use the Offset argument in two ways:<br />- When the Record argument is //acNext// or //acPrevious//, the cursor moves the number of records forward or backward specified in the Offset argument.<br />- When the Record argument is //acGoTo//, the cursor moves to the record with the number equal to the Offset argument. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acActiveDataObject = -1
Global Const acDataForm = 2
Global Const acFirst = 2
Global Const acGoTo = 4
Global Const acLast = 3
Global Const acNewRec = 5
Global Const acNext = 1
Global Const acPrevious = 0
//}}}
!!!Remarks
*The //~GoToRecord// action is most often started from an event. Clicking on a button in a form triggering the event might change the focus from the current form to the form containing the button. This could not be the desired effect. In that case use the [[setFocus]] method on the targeted //form// or alternatively the [[SelectObject]] action, before executing the //~GoToRecord// statement.
*An attempt to position the cursor beyond the first/last row in the result set leaves the cursor before/after the first/last row, respectively.
*If {{{Record}}} = //acGoTo// then:
**If the {{{Offset}}} is positive, the cursor moves to the given row number with respect to the beginning of the result set. The first row is row 1, the second is row 2, and so on.
**If the given {{{Offset}}} is negative, the cursor moves to an absolute row position with respect to the end of the result set. For example, {{{Offset}}} = (-1) positions the cursor on the last row, {{{Offset}}} = (-2) indicates the next-to-last row, and so on.
*Before moving to the indicated record, the current record is saved if it was either being created or being updated.
*//~GoToRecord// returns {{{True}}} if the move was successful, {{{False}}} otherwise.
!!!Error messages
|No active form or control found |
!!!See also
[[Bookmark]]
[[SelectObject]]
[[setFocus]]
!!!Example
<<tiddler "Gotorecord example">>
Jump to the 5th record before the last one
//{{{
GoToRecord , "myForm", acLast
GoToRecord , "myForm", acPrevious, 5
//}}}
{{firstletter{
@@color:#930;A@@
}}} //~GridControl// [[control|Control]] presents the records of a table or query in a tabular form.
!!!Functions returning a ~GridControl control
| !Function | !Type | !Arguments |!Description |
|[[Controls]] | [[Collection]] | Parent object<br />Integer or String |{{{Controls("myForm","myGridControl")}}} returns a control object corresponding with the {{{myGridControl}}} control in the {{{myForm}}} form. {{{myForm}}} must be open. |
|[[getObject]] || String |{{{getObject("Forms!myForm!myGridControl")}}} returns a control object corresponding with the {{{myGridControl}}} control in the {{{myForm}}} form. {{{myForm}}} must be open. |
!!!Properties
| !Property | !Type | !Read only |!Description or UNO object |
|[[Name]] || Y |Specifies the exact name of the control |
|BackColor |||Specifies the color of the interior of a control. |
|BorderColor |||Specifies the color of a control's border. |
|BorderStyle |||Specifies how a control's border appears. |
|[[ControlTipText]] |||Specifies the text that appears in a ~ScreenTip when you hold the mouse pointer over a control. |
|[[ControlType]] || Y |Specifies the type of a control. |
|[[Enabled]] |||Specifies if the cursor can access the control. |
|[[FontBold]]<br />[[FontItalic]]<br />[[FontName]]<br />[[FontSize]]<br />[[FontUnderline]]<br />[[FontWeight]]<br />[[ForeColor]] |||Specify the font characteristics of all the columns of the grid. |
|[[TabIndex]] |||Specifies a control's place in the tab order on a form. |
|[[TabStop]] |||Specifies whether you can use the TAB key to move the focus to a control. |
|[[Tag]] |||Stores extra information about a control. |
|[[Visible]] |||Specifies if a control is visible or hidden. |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the ~GridControl has the given property. |
!!!Remarks
Each //~GridControl// [[control object|Object Model]] has a Controls [[collection|Collection]], which contains all controls on the gridcontrol. You can refer to a specific control on a gridcontrol by referring to its [[Controls]] collection.
!!!Example
<<tiddler "Gridcontrol examples">>
Change font properties for ALL fields in a gridcontrol
//{{{
Dim ocGrid As Object
Set ocGrid = Controls("myForm", "myGridControl")
ocGrid.FontBold = True
//}}}
To know the controls present in a gridcontrol (datagrid)
//{{{
Dim i As Integer, iCountGrid As Integer
iCountGrid = ocGrid.Controls().Count
For i = 0 To iCountGrid - 1
Print ocGrid.Controls(i).Name,
Next i
Print
//}}}
The //Height// property specifies the height of a form
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
!!!Syntax
//form//{{{.Height}}}
//form//{{{.Height = }}}//value//
!!!Returned values / Arguments
{{{Integer}}} or {{{Long}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property 'Height' |
!!!See also
[[Maximize]]
[[Minimize]]
[[Move]]
[[Width]]
!!!Example
<<tiddler "Height & Width example">>
Modify height and width of a form
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
ofForm.Height = 300
ofForm.Width = 200
//}}}
!What is __~Access2Base__ ?
{{firstletter{
@@color:#930;A@@
}}}''ccess2Base'' is an ~OpenOffice/~LibreOffice extension for (business or personal) __application developers__ and __advanced users__.
It provides a AOO/~LibO Basic library of macros implementing a number of functionalities - directly inspired by //~MSAccess//. The macros are callable from an ''~OpenOffice/~LibreOffice Base'' application.
It is intended first to support people having a knowledge of ~MSAccess and willing to step over to a similar but free software, i.e. //~OpenOffice/~LibreOffice Base//. It is also useful for users having already a practical knowledge of ~OpenOffice/~LibreOffice and want to start building applications with it, while remaining focussed on the application or business logic only.
//It is also recommended to people having tried to program in AOO/~LibO Basic with the standard ~OpenOffice/~LibreOffice UNO API and having given it up ...//
The implemented macros include:
>1. a simplified and extensible ''__API__'' for [[forms|Forms]] and [[controls|Controls]] manipulations similar with the //~MSAccess// object model
>2. a number of actions with a syntax identical to their corresponding //~MSAccess// macros/actions
>3. the DLookup, DSum, ... database functions
>4. the support of the [[shortcut|ShortCut Notation]] notations like {{{Forms!myForm!myControl}}}
+
>5. a consistent [[errors and exceptions handler|Error Handler]]
>6. facilities for management of [[form and control events|Events Handler]]
>7. the support of both //embedded forms// and [[standalone (Writer) forms|Standalone Forms]]
!Compare ~Access2Base with ~MSAccess VBA
<<tiddler "Access2Base vs. VBA">>
!To know more ...
[[Why Access2Base ?]]
The [[Object model|Object Model]]
!What you can do ...
[[Download the extension and get started|DownLoad]]
Browse the [[User's Guide]]
/***
|Name|InlineJavascriptPlugin|
|Source|http://www.TiddlyTools.com/#InlineJavascriptPlugin|
|Documentation|http://www.TiddlyTools.com/#InlineJavascriptPluginInfo|
|Version|1.9.6|
|Author|Eric Shulman|
|License|http://www.TiddlyTools.com/#LegalStatements|
|~CoreVersion|2.1|
|Type|plugin|
|Description|Insert Javascript executable code directly into your tiddler content.|
''Call directly into TW core utility routines, define new functions, calculate values, add dynamically-generated TiddlyWiki-formatted output'' into tiddler content, or perform any other programmatic actions each time the tiddler is rendered.
!!!!!Documentation
>see [[InlineJavascriptPluginInfo]]
!!!!!Revisions
<<<
2010.12.15 1.9.6 allow (but ignore) type="..." syntax
|please see [[InlineJavascriptPluginInfo]] for additional revision details|
2005.11.08 1.0.0 initial release
<<<
!!!!!Code
***/
//{{{
version.extensions.InlineJavascriptPlugin= {major: 1, minor: 9, revision: 6, date: new Date(2010,12,15)};
config.formatters.push( {
name: "inlineJavascript",
match: "\\<script",
lookahead: "\\<script(?: type=\\\"[^\\\"]*\\\")?(?: src=\\\"([^\\\"]*)\\\")?(?: label=\\\"([^\\\"]*)\\\")?(?: title=\\\"([^\\\"]*)\\\")?(?: key=\\\"([^\\\"]*)\\\")?( show)?\\>((?:.|\\n)*?)\\</script\\>",
handler: function(w) {
var lookaheadRegExp = new RegExp(this.lookahead,"mg");
lookaheadRegExp.lastIndex = w.matchStart;
var lookaheadMatch = lookaheadRegExp.exec(w.source)
if(lookaheadMatch && lookaheadMatch.index == w.matchStart) {
var src=lookaheadMatch[1];
var label=lookaheadMatch[2];
var tip=lookaheadMatch[3];
var key=lookaheadMatch[4];
var show=lookaheadMatch[5];
var code=lookaheadMatch[6];
if (src) { // external script library
var script = document.createElement("script"); script.src = src;
document.body.appendChild(script); document.body.removeChild(script);
}
if (code) { // inline code
if (show) // display source in tiddler
wikify("{{{\n"+lookaheadMatch[0]+"\n}}}\n",w.output);
if (label) { // create 'onclick' command link
var link=createTiddlyElement(w.output,"a",null,"tiddlyLinkExisting",wikifyPlainText(label));
var fixup=code.replace(/document.write\s*\(/gi,'place.bufferedHTML+=(');
link.code="function _out(place,tiddler){"+fixup+"\n};_out(this,this.tiddler);"
link.tiddler=w.tiddler;
link.onclick=function(){
this.bufferedHTML="";
try{ var r=eval(this.code);
if(this.bufferedHTML.length || (typeof(r)==="string")&&r.length)
var s=this.parentNode.insertBefore(document.createElement("span"),this.nextSibling);
if(this.bufferedHTML.length)
s.innerHTML=this.bufferedHTML;
if((typeof(r)==="string")&&r.length) {
wikify(r,s,null,this.tiddler);
return false;
} else return r!==undefined?r:false;
} catch(e){alert(e.description||e.toString());return false;}
};
link.setAttribute("title",tip||"");
var URIcode='javascript:void(eval(decodeURIComponent(%22(function(){try{';
URIcode+=encodeURIComponent(encodeURIComponent(code.replace(/\n/g,' ')));
URIcode+='}catch(e){alert(e.description||e.toString())}})()%22)))';
link.setAttribute("href",URIcode);
link.style.cursor="pointer";
if (key) link.accessKey=key.substr(0,1); // single character only
}
else { // run script immediately
var fixup=code.replace(/document.write\s*\(/gi,'place.innerHTML+=(');
var c="function _out(place,tiddler){"+fixup+"\n};_out(w.output,w.tiddler);";
try { var out=eval(c); }
catch(e) { out=e.description?e.description:e.toString(); }
if (out && out.length) wikify(out,w.output,w.highlightRegExp,w.tiddler);
}
}
w.nextMatch = lookaheadMatch.index + lookaheadMatch[0].length;
}
}
} )
//}}}
// // Backward-compatibility for TW2.1.x and earlier
//{{{
if (typeof(wikifyPlainText)=="undefined") window.wikifyPlainText=function(text,limit,tiddler) {
if(limit > 0) text = text.substr(0,limit);
var wikifier = new Wikifier(text,formatter,null,tiddler);
return wikifier.wikifyPlain();
}
//}}}
// // GLOBAL FUNCTION: $(...) -- 'shorthand' convenience syntax for document.getElementById()
//{{{
if (typeof($)=='undefined') { function $(id) { return document.getElementById(id.replace(/^#/,'')); } }
//}}}
/***
|Name|InlineJavascriptPluginInfo|
|Source|http://www.TiddlyTools.com/#InlineJavascriptPlugin|
|Documentation|http://www.TiddlyTools.com/#InlineJavascriptPluginInfo|
|Version|1.9.6|
|Author|Eric Shulman|
|License|http://www.TiddlyTools.com/#LegalStatements|
|~CoreVersion|2.1|
|Type|documentation|
|Description|Documentation for InlineJavascriptPlugin|
''Call directly into TW core utility routines, define new functions, calculate values, add dynamically-generated ~TiddlyWiki-formatted output'' into tiddler content, or perform any other programmatic actions each time the tiddler is rendered.
!!!!!Usage
<<<
This plugin adds wiki syntax for surrounding tiddler content with {{{<script>}}} and {{{</script>}}} markers, so that it can be recognized as embedded javascript code. When a tiddler is rendered, the plugin automatically invokes any embedded scripts, which can be used to construct and return dynamically-generated output that is inserted into the tiddler content.
{{{
<script type="..." src="..." label="..." title="..." key="..." show>
/* javascript code goes here... */
</script>
}}}
All parameters are //optional//. When the ''show'' keyword is used, the plugin will also include the script source code in the output that it displays in the tiddler. This is helpful when creating examples for documentation purposes (such as used in this tiddler!)
__''Deferred execution from an 'onClick' link''__
<script label="click here" title="mouseover tooltip text" key="X" show>
/* javascript code goes here... */
alert('you clicked on the link!');
</script>
By including a {{{label="..."}}} parameter in the initial {{{<script>}}} marker, the plugin will create a link to an 'onclick' script that will only be executed when that specific link is clicked, rather than running the script each time the tiddler is rendered. You may also include a {{{title="..."}}} parameter to specify the 'tooltip' text that will appear whenever the mouse is moved over the onClick link text, and a {{{key="X"}}} parameter to specify an //access key// (which must be a //single// letter or numeric digit only).
__''Loading scripts from external source files''__
<script src="URL" show>
/* optional javascript code goes here... */
</script>You can also load javascript directly from an external source URL, by including a src="..." parameter in the initial {{{<script>}}} marker (e.g., {{{<script src="demo.js"></script>}}}). This is particularly useful when incorporating third-party javascript libraries for use in custom extensions and plugins. The 'foreign' javascript code remains isolated in a separate file that can be easily replaced whenever an updated library file becomes available.
In addition to loading the javascript from the external file, you can also use this feature to invoke javascript code contained within the {{{<script>...</script>}}} markers. This code is invoked //after// the external script file has been processed, and can make immediate use of the functions and/or global variables defined by the external script file.
>Note: To ensure that your javascript functions are always available when needed, you should load the libraries from a tiddler that is rendered as soon as your ~TiddlyWiki document is opened, such as MainMenu. For example: put your {{{<script src="..."></script>}}} syntax into a separate 'library' tiddler (e.g., ~LoadScripts), and then add {{{<<tiddler LoadScripts>>}}} to MainMenu so that the library is loaded before any other tiddlers that rely upon the functions it defines.
>
>Normally, loading external javascript in this way does not produce any direct output, and should not have any impact on the appearance of your MainMenu. However, if your ~LoadScripts tiddler contains notes or other visible content, you can suppress this output by using 'inline CSS' in the MainMenu, like this: {{{@@display:none;<<tiddler LoadScripts>>@@}}}
<<<
!!!!!Creating dynamic tiddler content and accessing the ~TiddlyWiki DOM
<<<
An important difference between ~TiddlyWiki inline scripting and conventional embedded javascript techniques for web pages is the method used to produce output that is dynamically inserted into the document: in a typical web document, you use the {{{document.write()}}} (or {{{document.writeln()}}}) function to output text sequences (often containing HTML tags) that are then rendered when the entire document is first loaded into the browser window.
However, in a ~TiddlyWiki document, tiddlers (and other DOM elements) are created, deleted, and rendered "on-the-fly", so writing directly to the global 'document' object does not produce the results you want (i.e., replacing the embedded script within the tiddler content), and instead will //completely replace the entire ~TiddlyWiki document in your browser window (which is clearly not a good thing!)//. In order to allow scripts to use {{{document.write()}}}, the plugin automatically converts and buffers all HTML output so it can be safely inserted into your tiddler content, immediately following the script.
''Note that {{{document.write()}}} can only be used to output "pure HTML" syntax. To produce //wiki-formatted// output, your script should instead return a text value containing the desired wiki-syntax content'', which will then be automatically rendered immediately following the script. If returning a text value is not sufficient for your needs, the plugin also provides an automatically-defined variable, 'place', that gives the script code ''direct access to the //containing DOM element//'' into which the tiddler output is being rendered. You can use this variable to ''perform direct DOM manipulations'' that can, for example:
* generate wiki-formatted output using {{{wikify("...content...",place)}}}
* vary the script's actions based upon the DOM element in which it is embedded
* access 'tiddler-relative' DOM information using {{{story.findContainingTiddler(place)}}}
Note:
''When using an 'onclick' script, the 'place' element actually refers to the onclick //link text// itself, instead of the containing DOM element.'' This permits you to directly reference or modify the link text to reflect any 'stateful' conditions that might set by the script. To refer to the containing DOM element from within an 'onclick' script, you can use "place.parentNode" instead.
<<<
!!!!!Instant "bookmarklets"
<<<
You can also use an 'onclick' link to define a "bookmarklet": a small piece of javascript that can be ''invoked directly from the browser without having to be defined within the current document.'' This allows you to create 'stand-alone' commands that can be applied to virtually ANY ~TiddlyWiki document... even remotely-hosted documents that have been written by others!! To create a bookmarklet, simply define an 'onclick' script and then grab the resulting link text and drag-and-drop it onto your browser's toolbar (or right-click and use the 'bookmark this link' command to add it to the browser's menu).
Notes:
*When writing scripts intended for use as bookmarklets, due to the ~URI-encoding required by the browser, ''you cannot not use ANY double-quotes (") within the bookmarklet script code.''
*All comments embedded in the bookmarklet script must ''use the fully-delimited {{{/* ... */}}} comment syntax,'' rather than the shorter {{{//}}} comment syntax.
*Most importantly, because bookmarklets are invoked directly from the browser interface and are not embedded within the ~TiddlyWiki document, there is NO containing 'place' DOM element surrounding the script. As a result, ''you cannot use a bookmarklet to generate dynamic output in your document,'' and using {{{document.write()}}} or returning wiki-syntax text or making reference to the 'place' DOM element will halt the script and report a "Reference Error" when that bookmarklet is invoked.
Please see ~InstantBookmarklets for many examples of 'onclick' scripts that can also be used as bookmarklets.
<<<
!!!!!Special reserved function name
<<<
The plugin 'wraps' all inline javascript code inside a function, {{{_out()}}}, so that any return value you provide can be correctly handled by the plugin and inserted into the tiddler. To avoid unpredictable results (and possibly fatal execution errors), this function should never be redefined or called from ''within'' your script code.
<<<
!!!!!$(...) 'shorthand' function
<<<
As described by Dustin Diaz [[here|http://www.dustindiaz.com/top-ten-javascript/]], the plugin defines a 'shorthand' function that allows you to write:
{{{
$(id)
}}}
in place of the normal standard javascript syntax:
{{{
document.getElementById(id)
}}}
This function is provided merely as a convenience for javascript coders that may be familiar with this abbreviation, in order to allow them to save a few bytes when writing their own inline script code.
<<<
!!!!!Examples
<<<
simple dynamic output:
><script show>
document.write("The current date/time is: "+(new Date())+"<br>");
return "link to current user: [["+config.options.txtUserName+"]]\n";
</script>
dynamic output using 'place' to get size information for current tiddler:
><script show>
if (!window.story) window.story=window;
var title=story.findContainingTiddler(place).getAttribute("tiddler");
var size=store.getTiddlerText(title).length;
return title+" is using "+size+" bytes";
</script>
dynamic output from an 'onclick' script, using {{{document.write()}}} and/or {{{return "..."}}}
><script label="click here" show>
document.write("<br>The current date/time is: "+(new Date())+"<br>");
return "link to current user: [["+config.options.txtUserName+"]]\n";
</script>
creating an 'onclick' button/link that accesses the link text AND the containing tiddler:
><script label="click here" title="clicking this link will show an 'alert' box" key="H" show>
if (!window.story) window.story=window;
var txt=place.firstChild.data;
var tid=story.findContainingTiddler(place).getAttribute('tiddler');
alert('Hello World!\nlinktext='+txt+'\ntiddler='+tid);
</script>
dynamically setting onclick link text based on stateful information:
>{{block{
{{{
<script label="click here">
/* toggle "txtSomething" value */
var on=(config.txtSomething=="ON");
place.innerHTML=on?"enable":"disable";
config.txtSomething=on?"OFF":"ON";
return "\nThe current value is: "+config.txtSomething;
</script><script>
/* initialize onclick link text based on current "txtSomething" value */
var on=(config.txtSomething=="ON");
place.lastChild.previousSibling.innerHTML=on?"disable":"enable";
</script>
}}}
<script label="click here">
/* toggle "txtSomething" value */
var on=(config.txtSomething=="ON");
place.innerHTML=on?"enable":"disable";
config.txtSomething=on?"OFF":"ON";
return "\nThe current value is: "+config.txtSomething;
</script><script>
/* initialize onclick link text based on current "txtSomething" value */
var on=(config.txtSomething=="ON");
place.lastChild.innerHTML=on?"enable":"disable";
</script>
}}}
loading a script from a source url:
>http://www.TiddlyTools.com/demo.js contains:
>>{{{function inlineJavascriptDemo() { alert('Hello from demo.js!!') } }}}
>>{{{displayMessage('InlineJavascriptPlugin: demo.js has been loaded');}}}
>note: When using this example on your local system, you will need to download the external script file from the above URL and install it into the same directory as your document.
>
><script src="demo.js" show>
return "inlineJavascriptDemo() function has been defined"
</script>
><script label="click to invoke inlineJavascriptDemo()" key="D" show>
inlineJavascriptDemo();
</script>
<<<
!!!!!Revisions
<<<
2010.12.15 1.9.6 allow (but ignore) type="..." syntax
2009.04.11 1.9.5 pass current tiddler object into wrapper code so it can be referenced from within 'onclick' scripts
2009.02.26 1.9.4 in $(), handle leading '#' on ID for compatibility with ~JQuery syntax
2008.06.11 1.9.3 added $(...) function as 'shorthand' for document.getElementById()
2008.03.03 1.9.2 corrected fallback declaration of wikifyPlainText() (fixes Safari "parse error")
2008.02.23 1.9.1 in onclick function, use string instead of array for 'bufferedHTML' (fixes IE errors)
2008.02.21 1.9.0 output from 'onclick' scripts (return value or document.write() calls) are now buffered and rendered into into a span following the script. Also, added default 'return false' handling if no return value provided (prevents HREF from being triggered -- return TRUE to allow HREF to be processed). Thanks to Xavier Verges for suggestion and preliminary code.
2008.02.14 1.8.1 added backward-compatibility for use of wikifyPlainText() in ~TW2.1.3 and earlier
2008.01.08 [*.*.*] plugin size reduction: documentation moved to ...Info tiddler
2007.12.28 1.8.0 added support for key="X" syntax to specify custom access key definitions
2007.12.15 1.7.0 autogenerate URI encoded HREF on links for onclick scripts. Drag links to browser toolbar to create bookmarklets. IMPORTANT NOTE: place is NOT defined when scripts are used as bookmarklets. In addition, double-quotes will cause syntax errors. Thanks to ~PaulReiber for debugging and brainstorming.
2007.11.26 1.6.2 when converting "document.write()" function calls in inline code, allow whitespace between "write" and "(" so that "document.write ( foobar )" is properly converted.
2007.11.16 1.6.1 when rendering "onclick scripts", pass label text through wikifyPlainText() to parse any embedded wiki-syntax to enable use of HTML entities or even TW macros to generate dynamic label text.
2007.02.19 1.6.0 added support for title="..." to specify mouseover tooltip when using an onclick (label="...") script
2006.10.16 1.5.2 add newline before closing '}' in 'function out_' wrapper. Fixes error caused when last line of script is a comment.
2006.06.01 1.5.1 when calling wikify() on script return value, pass hightlightRegExp and tiddler params so macros that rely on these values can render properly
2006.04.19 1.5.0 added 'show' parameter to force display of javascript source code in tiddler output
2006.01.05 1.4.0 added support 'onclick' scripts. When label="..." param is present, a button/link is created using the indicated label text, and the script is only executed when the button/link is clicked. 'place' value is set to match the clicked button/link element.
2005.12.13 1.3.1 when catching eval error in IE, e.description contains the error text, instead of e.toString(). Fixed error reporting so IE shows the correct response text. Based on a suggestion by ~UdoBorkowski
2005.11.09 1.3.0 for 'inline' scripts (i.e., not scripts loaded with src="..."), automatically replace calls to 'document.write()' with 'place.innerHTML+=' so script output is directed into tiddler content. Based on a suggestion by ~BradleyMeck
2005.11.08 1.2.0 handle loading of javascript from an external URL via src="..." syntax
2005.11.08 1.1.0 pass 'place' param into scripts to provide direct DOM access
2005.11.08 1.0.0 initial release
<<<
You can use the //~IsLoaded// property to specify if a form is currently loaded.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |A form, either open or not |
!!!Syntax
//form//{{{.IsLoaded}}}
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
The //~IsLoaded// property is read-only
!!!Error messages
!!!See also
!!!Example
<<tiddler "IsLoaded example">>
List all forms and specify which ones are open
//{{{
Dim ofForm As Object, iCount As Integer, i As Integer
iCount = AllForms.Count
For i = 0 To iCount - 1
Set ofForm = AllForms(i)
With ofForm
Print "Form " & .Name & " is " & Iif(.IsLoaded, "", "NOT ") & "open"
End With
Next i
Print
//}}}
The //~ItemData// property returns the data in the bound column for the specified row in a combo box or list box.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ComboBox]]<br />[[ListBox]] | [[ComboBox]]<br />[[ListBox]] |A combo- or listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.ItemData}}}
//control//{{{.ItemData(index)}}}
!!!Returned values / Arguments
{{{Array of Strings}}} (might be empty) if index is absent
{{{String}}} (might be null string) if index is present
!!!Remarks
The //~ItemData// property is read-only.
The //index// argument must have a (integer or long) value between 0 and (ListCount - 1)
!!!Error messages
|Argument nr.X is invalid |
|Property '~ItemData' not applicable in this context |
|Out of array range or incorrect array size for property '~ItemData'|
!!!See also
[[ListCount]]
[[ListIndex]]
[[MultiSelect]]
[[RowSource]]
[[RowSourceType]]
[[Selected]]
!!!Example
*Combo box
<<tiddler "ComboBox example">>
*List box
<<tiddler "ListBox example">>
(Q) I can't put all the numerous fields of a table on one single form. I need several forms and will navigate thru them with buttons. Of course, when I navigate thru records, I want to keep all open forms synchronized with the active one. How can I get that ?
(R) The synchronization will be obtained by using subforms and filters. However the challenge is to have one single concise code to do all the job.
Let's consider next tables:
<<tiddler "OrdersTable">>
<<tiddler "OrderDetailsTable">>
<<tiddler "CustomersTable">>
<<tiddler "ProductsTable">>
<<tiddler "EmployeesTable">>
We will use 4 forms:
*a //main// form and its subform for displaying Orders and their ~OrderDetails.
*3 //auxiliary// forms for displaying on request more details about the concerned Customer, Product or Employee.
*3 buttons (one for each of the 3 //auxiliary// forms) available from the //main// form activating the corresponding //auxiliary// form.
The trick is that when navigating among orders or order details, the open //auxiliary// forms remain synchronized with the //main// form and its subform.
!!!Synchronize all forms
Link next code to next events:
*//After record change// in the form events list
*//Mouse button pressed// control events of each of the 3 buttons
*//After record change// in the ''sub''form events list
//{{{
Sub SyncForms(poEvent As Object)
Dim ofForm As Object, oeEvent As Object, oTrigger As Object, oMainForm As Object
Dim sFilter As String, sEmployee As String, sCustomer As String, sProduct As String
Dim i As Integer, sForm As String
Const cstMainForm = "Orders_Details_Sync_Cust-Prod-Emp"
Const cstSuffix = "_Sync_Orders" ' Suffix of auxiliary form names
Set oeEvent = Events(poEvent)
Set oTrigger = oeEvent.Source ' Determine the trigger: one of the buttons ? or record navigation in main form ?
' or record navigation in subform ?
Set oMainForm = AllForms(cstMainForm)
If Not oMainForm.IsLoaded Then Goto Exit_Sub ' May happen at form loading or closure
If Left(oTrigger.Name, Len("btn")) = "btn" Then ' Triggered by buttons btnCustomers, btnProducts or btnEmployees
sForm = Right(oTrigger.Name, Len(oTrigger.Name)- Len("btn")) & cstSuffix
Set ofForm = AllForms(sForm) ' AllForms() collects all forms, whether open or not
If ofForm.IsLoaded Then setFocus(ofForm) Else OpenForm(sForm)
End If
'Determine filters
sCustomer = "[CustomerID]='" & oMainForm.Controls("txtCustomerID").Value & "'" ' String !!!
sProduct = "[ProductID]=" & oMainForm.Controls("SubForm").Form.Controls("SubForm_Grid").Controls("ProductID").Value
sEmployee = "[EmployeeID]=" & oMainForm.Controls("fmtEmployeeID").Value
For i = 0 To Forms().Count - 1 ' Forms() collects all open forms
Set ofForm = Forms(i)
sFilter = ""
Select Case Split(ofForm.Name, cstSuffix)(0)
Case "Customers" : sFilter = sCustomer
Case "Products" : sFilter = sProduct
Case "Employees" : sFilter = sEmployee
Case Else ' Ignore any other open form
End Select
If Len(sFilter) > 0 Then
ofForm.Filter = sFilter
ofForm.FilterOn = True
End If
Next i
Exit_Sub:
Set ofForm = Nothing
Set oeEvent = Nothing
Set oTrigger =Nothing
Set oMainForm = Nothing
Exit Sub
End Sub
//}}}
!!!To close all the forms simultaneously when the main form is closed
Link next Sub to the //Closed a sub component// event of the database file (Use the {{{Tools + Customize ... + Events}}} menu items).
//{{{
Sub SyncCloseForms(poEvent As Object)
' Fired at each component closure !!
Dim oEvent As Object, ofForm As Object, i As Integer, iCount As Integer, vNames() As Variant
Const acForm = 2
Const cstMainForm = "Orders_Details_Sync_Cust-Prod-Emp"
Const cstSuffix = "_Sync_Orders" ' Suffix of auxiliary form names
Set oEvent = Events(poEvent)
If oEvent.SubComponentName <> cstMainForm Then Exit Sub
iCount = Forms().Count
If iCount = 0 Then Exit Sub
ReDim vNames(0 To iCount - 1)
For i = 0 To UBound(vNames) ' Store names before closing otherwise risk of "Index out of range"
vNames(i) = Forms(i).Name
Next i
For i = 0 To UBound(vNames)
Set ofForm = Forms(vNames(i))
If Len(ofForm.Name) > Len(cstSuffix) And ofForm.Name <> cstMainForm Then
If Right(ofForm.Name, Len(cstSuffix)) = cstSuffix Then ofForm.mClose()
End If
Next i
End Sub
//}}}
!!!See also
[[AllForms]]
[[Close (method)]]
[[Event]]
[[Filter]]
[[FilterOn]]
[[Forms]]
You can use the ~LinkChildFields property (along with the LinkMasterFields property together) to know how the records in a form are linked to records in a subform.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[SubForm]] | None |A subform of an open form or another subform |
!!!Syntax
//control//{{{.LinkChildFields}}}
//control//{{{.LinkChildFields(index)}}}
!!!Returned values
Array of {{{Strings}}} or {{{String}}}
!!!Remarks
The ~LinkChildFields property is read-only.
The array can be empty. In this case the {{{UBound()}}} function applied on that array will return {{{-1}}}.
!!!Error messages
|Argument nr.X is invalid |
|Property '~LinkChildFields' not applicable in this context |
|Out of array range or incorrect array size for property '~LinkChildFields' |
!!!See also
[[LinkMasterFields]]
!!!Example
<<tiddler "Linkfields example">>
You can use the ~LinkMasterFields property (along with the LinkChildFields property together) to know how the records in a form are linked to records in a subform.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[SubForm]] | None |A subform of an open form or another subform |
!!!Syntax
//control//{{{.LinkMasterFields}}}
//control//{{{.LinkMasterFields(index)}}}
!!!Returned values
Array of {{{Strings}}} or {{{String}}}
!!!Remarks
The ~LinkMasterFields property is read-only.
The array can be empty. In this case the {{{UBound()}}} function applied on that array will return {{{-1}}}.
!!!Error messages
|Argument nr.X is invalid |
|Property '~LinkMasterFields' not applicable in this context |
|Out of array range or incorrect array size for property '~LinkMasterFields' |
!!!See also
[[LinkChildFields]]
!!!Example
<<tiddler "Linkfields example">>
List all the master / children fields of a subform
//{{{
Dim ocSubform As Object, i As Integer, iCount As Integer
Set ocSubform = getValue("Forms!myForm!mySubform.Form")
iCount = UBound(ocSubform.LinkMasterFields)
For i = 0 To iCount
Print "Master " & ocSubform.LinkMasterFields(i) & " is linked to " & ocSubform.LinkChildFields(i),
Next i
Print
//}}}
{{firstletter{
@@color:#930;A@@
}}} //~ListBox// describes a list box control. It has specific properties to manage the input list of potential values and to select one or more of them programmatically.
A ~ListBox control is returned by the [[Controls]] collection or by the [[getObject]] shortcut.
!!!Specific properties for list box management
| !Property | !Type | !Read only | !Description |
|[[ItemData]] | Variant array | Y |Returns the data for the specified row in a combo box or list box. |
|[[ListCount]] | Integer<br />Long | Y |Determines the number of rows in a ~ListBox or the list box portion of a [[ComboBox]]. |
|[[ListIndex]] | Integer<br />Long ||Determines which item is selected in a ~ListBox or a [[ComboBox]]. |
|[[MultiSelect]] | Boolean ||Specifies whether a user can make multiple selections in a ~ListBox on a form. |
|[[RowSource]] | String ||Specifies the source of the data in a ~ListBox or a [[ComboBox]]. |
|[[RowSourceType]] | String ||Specifies the source (tablename, queryname or SQL statement) of the data in a ~ListBox or a [[ComboBox]]. |
|[[Selected]] | Boolean array ||Specifies if an item in the data proposed by a ~ListBox is currently selected. |
|[[Value]] | Variant ||Specifies the value contained in the (~MultiSelect = False !) ~ListBox. |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the ~ListBox has the given property. |
|[[Requery]] || Boolean |Reload the data in the ~ListBox and return True. |
!!!Remarks
*A //~ListBox// may or not have a second (hidden) column which is bound to the underlying data in the database. It is most often an index, the visible column being a readable label associated with that index. When it is the case the //Value// property contains the value in the index column.
*If no item is selected in the //~ListBox//, the //~ListIndex// property is set to {{{-1}}} and the //Selected// array contains {{{False}}} in all its entries. If //~MutliSelect// is {{{True}}} Then //~ListIndex// always returns {{{-1}}}
!!!See also
[[ComboBox]]
!!!Example
<<tiddler "ListBox example">>
//{{{
REM Display the selected rows of a (multiselect) listbox
Dim i As Integer, ocList As Object
Set ocList = getObject("Forms!myForm!myListBox")
For i = 0 To ocList.ListCount - 1
If ocList.Selected(i) Then Print i & " - " & ocList.ItemData(i),
Next i
REM Select all options
For i = 0 To ocList.ListCount - 1
setSelected(ocList, True, i)
Next i
Print
//}}}
You can use the //~ListCount property// to determine the number of rows in a list box or the list box portion of a combo box.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ComboBox]]<br />[[ListBox]] | [[ComboBox]]<br />[[ListBox]] |A combo- or listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.ListCount}}}
!!!Returned values
{{{Long}}}
!!!Remarks
The //~ListCount// property is read-only.
!!!Error messages
|Property '~ListCount' not applicable in this context |
!!!See also
[[ItemData]]
[[ListIndex]]
[[MultiSelect]]
[[RowSource]]
[[RowSourceType]]
[[Selected]]
!!!Example
*Combo box
<<tiddler "ComboBox example">>
*List box
<<tiddler "ListBox example">>
You can use the //~ListIndex// property to determine which item is selected in a list box or combo box.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ComboBox]]<br />[[ListBox]] | [[ComboBox]]<br />[[ListBox]] |A combo- or listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.ListIndex}}}
//control//{{{.ListIndex}}} = //value//
!!!Returned values / Arguments
{{{Long}}} in interval [0, //~ListCount// - 1] or (-1)
!!!Remarks
If the control is a [[MultiSelect]] listbox, or if there is no item selected, then the //~ListIndex// property returns {{{-1}}}
!!!Error messages
|Property '~ListIndex' not applicable in this context |
|Value '...' is invalid for property '~ListIndex' |
!!!See also
[[ItemData]]
[[ListCount]]
[[MultiSelect]]
[[RowSource]]
[[RowSourceType]]
[[Selected]]
!!!Example
*Combo box
<<tiddler "ComboBox example">>
*List box
<<tiddler "ListBox example">>
The //Locked// property specifies if the control is read only.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |[[ComboBox]]<br />~CurrencyField<br />~DateField<br />~FileControl<br />~FormattedField<br />~ImageControl<br />[[ListBox]]<br />~NumericField<br />~PatternField<br />~TextField<br />~TimeField | All except<br />--~CheckBox-- |A control on an open form |
!!!Syntax
//control//{{{.Locked}}}
//control//{{{.Locked}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property 'Locked' not applicable in this context |
|Value '...' is invalid for property 'Locked' |
!!!See also
[[Enabled]]
!!!Example
<<tiddler "Enabled & Locked example">>
//[[Software Version: 0.9.0|ReleaseNotes]]//
[[Home|Home]]
<<search>>
[[Index|Index]]
[[Download|DownLoad]]
[[Tips & Tricks|Tips&Tricks]]
<<tagsTree Menu>>
[[Thanks|Thanks]]
[[Contact]]
<<toggleSideBar "" "Toggle side bar" hide>>
{{firstletter{
@@color:#930;T@@
}}}he //Maximize// [[action|Actions]] maximizes the window containing the [[Form]] having the focus.
!!!Syntax
{{{Maximize()}}}
!!!Remarks
*The //Maximize// action is usually preceded by a [[SelectObject]] action or by a [[setFocus]] method applied on the targeted //form//.
*//Maximize// returns {{{True}}} if the action was successful, {{{False}}} otherwise.
!!!Error messages
|No active form or control found |
!!!See also
[[Minimize]]
[[SelectObject]]
[[setFocus]]
!!!Example
<<tiddler "Maximize example">>
Set focus on targeted form and maximize it
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
ofForm.setFocus
Maximize() ' ... or Minimize() ...
MsgBox ofForm.Width
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //Minimize// [[action|Actions]] minimizes the window containing the [[Form]] having the focus.
!!!Syntax
{{{Minimize()}}}
!!!Remarks
*The //Minimize// action requires ''at least version 3.3 of ~OpenOffice''. In older versions the action is ignored.
*The //Minimize// action is usually preceded by a [[SelectObject]] action or by a [[setFocus]] method applied on the targeted //form//.
*//Minimize// returns {{{True}}} if the action was successful, {{{False}}} otherwise.
!!!Error messages
|No active form or control found |
!!!See also
[[Maximize]]
[[SelectObject]]
[[setFocus]]
!!!Example
<<tiddler "Maximize example">>
(Q) Is it possible to mix calls to the //~Access2Base// API and to the //UNO// API in the same code ?
(R) Yes, this is by the way exactly what //~Access2Base// does internally. Additionally most [[Access2Base objects|Object Model]] provide entries to useful //UNO// objects.
!!!Documentation
Next objects have within their properties one or more of them qualified as "UNO". Have a look at:
*[[Database]]
*[[Form]]
*[[Control]] with the - very useful - //~ControlModel// and //~ControlView// properties
*[[SubForm]]
!!!Example 1
To get the character surrounding table and fieldnames in SQL statements for the current database:
//{{{
MsgBox CurrentDb.MetaData.IdentifierQuoteString
//}}}
[[CurrentDb]] returns the current database object making its //metadata// property available.
!!!Example 2
Next function (inspired by a code snippet from [[XRay|http://bernard.marcelly.perso.sfr.fr/index2.html]]) returns the nature of a //UNO// object:
//{{{
Public Function getUNOTypeName(pvObject As Variant) As String
' Return the symbolic name of the pvObject (UNO-object) type
' Code-snippet from XRAY
Dim oService As Object, vClass as Variant, sType As String
_getUNOTypeName = ""
On Local Error Resume Next
sType = pvObject.getImplementationName()
If sType = "" Then
oService = CreateUnoService("com.sun.star.reflection.CoreReflection")
vClass = oService.getType(pvObject)
If vClass.TypeClass = com.sun.star.uno.TypeClass.STRUCT Then
getUNOTypeName = vClass.Name
End If
oService.Dispose()
End If
getUNOTypeName = sType
End Function ' getUNOTypeName
//}}}
Next code will probably display //com.sun.star.comp.forms.~ODatabaseForm//
//{{{
Dim ofForm As Object
Set ofForm = Forms("Orders_Browse")
MsgBox getUNOTypeName(ofForm.DatabaseForm)
//}}}
!!!Example 3
To apply a font attribute that is not implemented within the //~Access2Base// API:
//{{{
Dim ocControl As Object
Set ocControl = Forms("Orders_Browse").Controls("txtCustomerID")
ocControl.ControlModel.FontStrikeout = com.sun.star.awt.FontStrikeout.DOUBLE
//}}}
The //Move// method moves the specified object to the coordinates specified by the argument values.
!!!Applies to ...
| !Object | !Description |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice// database form |
!!!Syntax
//form//.{{{Move(}}}//Left//{{{[, }}}//Top//{{{][, }}}//Width//{{{][, }}}//Height//{{{])}}}
| !Argument | !Type | !Description | !Returned value |
| form |[[Form object|Form]] |Form to be moved |//True// if success. |
| Left | Integer<br />Long |The screen position for the left edge of the form relative to the left edge of the screen |~|
| Top | Integer<br />Long |The screen position for the top edge of the form relative to the top edge of the screen |~|
| Width | Integer<br />Long |The desired width of the form |~|
| Height | Integer<br />Long |The desired height of the form |~|
!!!Remarks
!!!Error messages
|Argument nr.X is invalid |
!!!See also
[[Height]]
[[MoveSize]]
[[Width]]
!!!Example
<<tiddler "Move example">>
Move a form to new left-top coordinates and resize it ...
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
ofForm.Move(100, 200, 500, 200)
//}}}
The //MoveSize// [[action|Actions]] moves the active window to the coordinates specified by the argument values.
!!!Syntax
{{{MoveSize(}}}//Right//{{{[, }}}//Down//{{{, }}}//Width//{{{, }}}//Height//
| !Argument | !Optional | !Type | !Description | !Returned value |
| Right | Yes |Integer<br />Long |The screen position for the left edge of the window relative to the left edge of the screen | True if success |
| Down |~| Integer<br />Long |The screen position for the top edge of the window relative to the top edge of the screen |~|
| Width |~| Integer<br />Long |The desired width of the window |~|
| Height |~| Integer<br />Long |The desired height of the window |~|
!!!Remarks
*The action applies to the active window. A window may be made active with [[SelectObject]] action.
*The //~MoveSize// action is also applicable to the Basic IDE window or the database window. However it will ignore any window opened by another application than Base.
*The [[Move]] method applies to [[forms|Form]] only.
!!!Error messages
|Argument nr.X is invalid |
!!!See also
[[Height]]
[[Move]]
[[SelectObject]]
[[Width]]
!!!Example
<<tiddler "MoveSize example">>
Select an open form and resize it
//{{{
SelectObject(acForm, "myForm")
MoveSize 100, 200, 500, 200
//}}}
You can use the ~MultiSelect property to specify whether a user can make multiple selections in a list box on a form
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ListBox]] | [[ListBox]] |A listbox on an open form |
!!!Syntax
//control//{{{.MultiSelect}}}
//control//{{{.MultiSelect}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
In ~MSAccess VBA the //~MultiSelect// property returns an integer value.
!!!Error messages
|Property '~MultiSelect' not applicable in this context |
|Value '...' is invalid for property '~MultiSelect' |
!!!See also
[[ItemData]]
[[ListCount]]
[[ListIndex]]
[[RowSource]]
[[RowSourceType]]
[[Selected]]
!!!Example
*Combo box
<<tiddler "ComboBox example">>
*List box
<<tiddler "ListBox example">>
(Q) I have a listbox control (might be MultiSelect) on my form. I want to pass the selected items to select the data listed in a gridcontrol on the same form. How do I do this?
(R) The criteria must be built as a character string and passed to the [[RecordSource]] of the form.
Assuming next tables:
<<tiddler "SuppliersTable">>
<<tiddler "ProductsTable">>
and a form
*bound to the Table "Products"
*containing an unbound listbox having as data source
//{{{
SELECT "CompanyName" FROM "Suppliers" ORDER BY "CompanyName" ASC
//}}}
!!!Solution for ~MultiSelect = No listbox
We make the //Changed// event of the listbox control triggering next code:
//{{{
Sub SyncFormListBoxMono(poEvent As Object)
Dim oEvent As Object, ocList As Object, oForm As Object
Dim sSupplier As String, lSupplier As Long
Set oEvent = Events(poEvent)
Set ocList = oEvent.Source ' Retrieve listbox object
Set oForm = ocList.Parent ' Retrieve parent form
sSupplier = Join(Split(ocList.Value, "'"), "''") ' For the case the company name contains quotes
lSupplier = DLookup("[SupplierID]", "[Suppliers]", "[CompanyName]='" & sSupplier & "'")
oForm.RecordSource = "SELECT [SupplierID], [ProductID], [ProductName], [UnitPrice] FROM [Products] WHERE [SupplierID]=" & lSupplier
End Sub
//}}}
This will produce the requested effect.
!!!Solution for ~MultiSelect = Yes listbox
A first variant is when the listbox is defined with ~MultiSelection = Yes
//{{{
Sub SyncFormListBoxMulti(poEvent As Object)
Dim oEvent As Object, ocList As Object, oForm As Object
Dim sSupplier As String, lSupplier As Long, i As Integer, sSQL As String
Const cstCriteria = " OR [SupplierID]="
Set oEvent = Events(poEvent)
Set ocList = oEvent.Source ' Retrieve listbox object
Set oForm = ocList.Parent ' Retrieve parent form
sSQL = "SELECT [SupplierID], [ProductID], [ProductName], [UnitPrice] FROM [Products] WHERE [SupplierID]="
For i = 0 To UBound(oclist.Selected)
If ocList.Selected(i) Then
sSupplier = Join(Split(ocList.ItemData(i), "'"), "''") ' For the case the company name contains quotes
lSupplier = DLookup("[SupplierID]", "[Suppliers]", "[CompanyName]='" & sSupplier & "'")
sSQL = sSQL & lSupplier & cstCriteria
End If
Next i
oForm.RecordSource = Left(sSQL, Len(sSQL) - Len(cstCriteria)) ' Trim SQL phrase
End Sub
//}}}
!!!Solution with form filtering
Another variant is to use a filter. This lets the user the freedom to cancel the filtering option or to filter the data independently from the listbox. This freedom can be desired by the developer or not. ~MultiSelection is presumed False in the example:
//{{{
Sub SyncFormListBoxFilter(poEvent As Object)
Dim oEvent As Object, ocList As Object, oForm As Object
Dim sSupplier As String, lSupplier As Long
Set oEvent = Events(poEvent)
Set ocList = oEvent.Source ' Retrieve listbox object
Set oForm = ocList.Parent ' Retrieve parent form
sSupplier = Join(Split(ocList.Value, "'"), "''") ' For the case the company name contains quotes
lSupplier = DLookup("[SupplierID]", "[Suppliers]", "[CompanyName]='" & sSupplier & "'")
oForm.Filter = "[SupplierID]=" & lSupplier
oForm.FilterOn = True
End Sub
//}}}
!!!See also
[[getObject]]
[[Events Handler]]
[[Filter]]
[[Parent]]
[[RecordSource]]
The //Name// property specifies the text string corresponding to the name of an object.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |A form, open or not |
|[[SubForm]] |A subform of an open form |
|[[Control]] |A control of an open form |
|[[OptionGroup]] |A group of radio buttons |
|[[Property]] |A property of an object |
!!!Syntax
//form//{{{.Name}}}
//subform//{{{.Name}}}
//control//{{{.Name}}}
//optiongroup//{{{.Name}}}
//property//{{{.Name}}}
!!!Returned values
{{{String}}}
!!!Remarks
*The Name property is read-only.
*The returned string contains the name of the object __as stored by ~OpenOffice/~LibreOffice Base__. In ~OpenOffice/~LibreOffice Base "myForm" is different from "MYFORM". At the opposite, in ~Access2Base, all references to a name as argument of a function are //''not case-sensitive''//.<br />Example: {{{Forms("myForm")}}} is identical to {{{Forms("MYFORM")}}}
!!!Error messages
!!!Example
<<tiddler "Name example">>
Display exact name of the first open form
Display all property names of that form
//{{{
Dim ofForm As Object, opProperty As Object, i As Integer
If Forms.Count > 0 Then
Set ofForm = Forms(0)
_Print ofForm.Name
For i = 0 To ofForm.Properties().Count - 1
Set opProperty = ofForm.Properties(i)
Print opProperty.Name,
Next i
End If
Print
//}}}
{{firstletter{
@@color:#930;A@@
}}}OO/~LibO Basic is a rudimentary object-oriented language.
To stay close to the syntax of the //~MSAccess// object model the implementation of ~Access2Base has been based on BASIC object classes as well. Their main characteristics are (see below for more details):
*Use of variables of types Form, Subform or Control, etc.
*Property and method names are identical in //~MSAccess// and in //~Access2Base//. Note however that //~Access2Base// implements only a limited subset of the object model of //~MSAccess//.
*Support of indirection and introspection for properties.
!Objects classes
The classes of objects currently supported by the //~Access2Base// API are:
| !Class | !Description |
|[[Collection]] |An array of objects accessible via their index |
|[[Database]] |The single database to which the Base application is connected |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice// database form |
|[[Control]] |The representation of a control within a Form (or SubForm) |
|[[SubForm]] |Identifies a specific control which is a subform of a database form or another subform |
|[[OptionGroup]] |Identifies a group of specific controls, i.e. radio buttons. |
|[[Property]] |A name-value pair allowing objects introspection (see below) |
|[[Event|Events]] |A description of an occurred form or control event |
The object class is returned for all objects as a string by the [[ObjectType]] property.
!Collections - Functions returning objects
Objects are created by the invocation of specific functions included in the API. In the calling procedure an object is defined as a variable of type //Object//.
Example:
//{{{
Dim ofForm As Object ' Variant would also be correct
Set ofForm = AllForms("myForm") ' The Set verb is mandatory in MSAccess but optional in AOO/LibO Basic
//}}}
{{{ofForm}}} contains after execution the instance of an object of class Form.
{{{AllForms}}} is called a [[collection|Collection]]. Individual members of a collection are reachable either by their index or by their name.
!Properties
!!!Property types
Within an object class one can distinguish next property types:
| !Type of property | !Description |
|UNO |The property refers to a UNO object that can be used from user macros to invoke directly more sophisticated properties and methods than those supported by the //~Access2Base// API |
|Normal |Where it is really about in the //~Access2Base// software |
!!!Property names
The names of the properties are identical to their equivalent in //~MSAccess//.
However
*the semantics of the property might differ more or less
*the list of allowed values might be different
Read the documentation about each individual property for more info.
!!!Get properties
To get the value of a __normal__ property named "~MyProperty", it is strictly equivalent to write
{{indent{{{{vValue = myObject.MyProperty}}}
or
{{indent{{{{vValue = getMyProperty(myObject)}}}
Depending on the context an error message can be generated stopping the execution of the macro. The error message can be issued either by AOO/~LibO Basic or by the API.
If the property is an array use either
{{indent{{{{vValue = myObject.MyProperty(i)}}}
or
{{indent{{{{vValue = getMyProperty(myObject, i)}}}
!!!Set properties
To set the value of a __normal__ property named "~MyProperty", next syntaxes are allowed:
{{indent{{{{myObject.MyProperty[(i)] = vValue}}}
or
{{indent{{{{setMyProperty(myObject, vValue[, i])}}}
the last optional argument being the index if the property returns an array.
The macro will be stopped if the property setting failed.
!!!Indirection
To get the value of a __normal__ property of an object, one can write also:
{{indent{{{{vValue = myObject.getProperty("MyProperty"[, i])}}}
To set its value:
{{indent{{{{myObject.setProperty("MyProperty", vValue[, i])}}}
!!!Introspection
Finally it is possible to get the value of ALL normal properties of an object with the //Properties// function as in next example:
//{{{
Dim ofForm As Object, i As Integer, oProperty As Object
Set ofForm = AllForms("myForm")
For i = 0 To ofForm.Properties().Count - 1
Set oProperty = ofForm.Properties(i)
Print oProperty.Name & " = " & oProperty.Value & " / ",
Next i
Print
//}}}
Additionally all objects have a {{{hasProperty}}} method indicating if the given property argument is applicable or not, like in:
//{{{
Dim ofForm As Object
Set ofForm = AllForms("myForm")
If ofForm.hasProperty("AllowEdits") Then
...
End If
//}}}
!Methods
In this context only the methods performing another action than //Get// ting or //Set// ting a property are considered.
!!!Method names
The names of the methods are identical to their equivalent in //~MSAccess//.
However
*when the name is a ''reserved word'' in AOO/~LibO Basic the name is preceded by a "m" (like in method). E.g. //mClose// replaces //Close//
*the semantics of the property might differ more or less
*the arguments might be different in number or in possible values
Read the documentation about each individual method for more info.
!!!Syntax
Example:
//{{{
Dim ofForm As Object
Set ofForm = AllForms("myForm")
ofForm.Move(100, 200)
//}}}
!Compatibility
To keep the compatibility of existing programs written with //~Access2Base// versions older than 0.9.0, the invocation of properties and methods like in
>{{{getPROPERTY(OBJECT)}}}
>{{{setPROPERTY(OBJECT, }}}//value//{{{)}}}
>{{{METHOD(OBJECT, }}}//arg1, ...//{{{)}}
is still supported.
Type the text for 'Object Properties'
The //~ObjectType// property specifies the type of an [[object|Object Model]].
!!!Applies to ...
| !Object |!Description |
|[[Database]] |The current database object |
|[[Collection]] |A collection of objects |
|[[Form]] |A form, open or not |
|[[SubForm]] |A subform of an open form |
|[[Control]] |A control of an open form |
|[[OptionGroup]] |A group of radio buttons |
|[[Event]] |An event object triggered by a form or control event |
|[[Property]] |A property of an object |
!!!Syntax and returned values
| !Syntax | !Returned string |
|//database//{{{.ObjectType}}} |"DATABASE" |
|//collection//{{{.ObjectType}}} |"COLLECTION" |
|//form//{{{.ObjectType}}} |"FORM" |
|//subform//{{{.ObjectType}}} |"SUBFORM" |
|//control//{{{.ObjectType}}} |"CONTROL" |
|//optiongroup//{{{.ObjectType}}} |"OPTIONGROUP" |
|//event//{{{.ObjectType}}} |"EVENT" |
|//property//{{{.ObjectType}}} |"PROPERTY" |
!!!Remarks
The //~ObjectType// property is read-only.
The //~OpenArgs// property determines the expression that was passed as argument of an [[OpenForm]] action.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
!!!Syntax
//form//{{{.OpenArgs}}}
!!!Returned values
{{{Variant}}}
!!!Remarks
*The //~OpenArgs// property is read-only.
*Being a variant, the ~OpenArgs argument of the OpenForm action might contain a complex value allowing complex processing (see example).
*The //form// argument must be the [[object|Object Model]] returned by the OpenForm action. Otherwise the ~OpenArgs property always returns a zero-length string. The //~OpenArgs// property applied to a [[standalone form|Standalone Forms]] always returns a zero-length string.
!!!Error messages
!!!See also
[[Tag]]
!!!Example
<<tiddler "OpenArgs example">>
In a 1st step open a form with the ~OpenArgs argument
//{{{
Dim ofForm As Object
Const acNormal = 0
Set ofForm = OpenForm("myForm", acNormal, , , , , Array("MICKEY", "WINNIE"))
//}}}
In a 2nd step compute a filter based on the ~OpenArgs property
//{{{
Dim sFilter As String, i As Integer
sFilter = ""
For i = 0 To UBound(ofForm.OpenArgs)
sFilter = sFilter & Iif(i=0, "", " Or ") & "[EMPLOYEE].[NAME] LIKE '*" & ofForm.OpenArgs(i) & "*'"
Next i
ofForm.Filter = sFilter
ofForm.FilterOn = True
//}}}
{{firstletter{
@@color:#930;T@@
}}}he invocation of the //~OpenConnection// as a Sub is mandatory before any other use of the //~Access2Base// API. It establishes a link between the current database and all subsequent references to forms, etc. belonging to the current database document (".odb" file).
!!!Syntax when invoked from a usual Base document (.odb file)
{{{Call OpenConnection(ThisDatabaseDocument, }}}//{{{Username, Password}}}//{{{)}}}
| !Argument | !Optional | !Type |!Description |
|{{{ThisDatabaseDocument}}} | No | com.sun.star.comp.dba.~ODatabaseDocument |Must be exactly spelled as is. |
|{{{Username}}} | Yes | String |The connection parameters to the effective database, if any. |
|{{{Password}}} |~|~|~|
!!!Syntax when invoked from a standalone form (.odt file)
{{{Call OpenConnection(ThisComponent)}}}
| !Argument | !Optional |!Description |
|{{{ThisComponent}}} | No |Must be exactly spelled as is. |
!!!See also
[[Database]]
[[CurrentDb]]
[[DownLoad]]
[[Standalone Forms]]
!!!Example
The Call ~OpenConnection sentence is usually stored in the macro linked to the //~OpenDocument event// of the database document (".odb" file):
<<tiddler "Openconnection example">>
<<tiddler "CurrentDb example">>
<<tiddler "Standalone Connect example">>
{{firstletter{
@@color:#930;T@@
}}}he //~OpenForm// [[action|Actions]] opens a form in Form view or in form Design view. You can select data entry and window modes for the form and restrict the records that the form displays.
!!!Syntax
{{{OpenForm(}}}//{{{FormName, View, Filter, WhereCondition, DataMode, WindowMode, OpenArgs}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{FormName}}} | No | String |The name of the form to open. |
|{{{View}}} | Yes | acDesign<br />acNormal<br />acPreview |The view in which the form will open.<br />//acNormal// and //acPreview// are equivalent. Default is //acNormal//. |
|{{{Filter}}} |~| String |A valid __SQL WHERE clause__ (without the word WHERE). |
|{{{WhereCondition}}} |~| String |A valid __SQL WHERE clause__ (without the word WHERE). |
|{{{DataMode}}} |~| acFormAdd<br />acFormEdit<br />acFormPropertySettings<br />acFormReadOnly |Specifies if the user will be allowed to add new records (//acFormAdd//), add new and edit existing records (//acFormEdit//) or only read existing records (//acFormReadOnly//). //acFormPropertySettings// refers to the settings at form creation.<br />Only //acFormEdit// alows record deletions. |
|{{{WindowMode}}} |~| acHidden<br />acWindowNormal |Default is //acWindowNormal//. |
|{{{OpenArgs}}} |~| String |The string is used to set the form's [[OpenArgs]] property. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acDesign = 1
Global Const acNormal = 0
Global Const acPreview = 2
Global Const acFormAdd = 0
Global Const acFormEdit = 1
Global Const acFormPropertySettings = -1
Global Const acFormReadOnly = 2
Global Const acHidden = 1
Global Const acWindowNormal = 0
//}}}
!!!Remarks
*The //Filter// and //~WhereCondition// arguments are simply concatenated and applied as filter to the form:
//{{{
( Filter ) And ( WhereCondition )
//}}}
*The //~OpenForm// action returns a [[Form]] object.
*If the //view// argument is //acDesign//, the form will get opened in Design mode. However any further action is not supported by the ~Access2Base API.
!!!Error messages
|Form '...' could not be opened |
!!!See also
[[AllowAdditions]]
[[AllowDeletions]]
[[AllowEdits]]
[[Close]]
[[Filter]]
[[FilterOn]]
[[OpenArgs]]
[[OpenQuery]]
[[OpenReport]]
[[OpenTable]]
!!!Example
<<tiddler "Openform example">>
{{firstletter{
@@color:#930;T@@
}}}he //~OpenQuery// [[action|Actions]] opens a query in normal view or in query design view.
!!!Syntax
{{{OpenQuery(}}}//{{{QueryName, View, DataMode}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{QueryName}}} | No | String |The name of the query to open. This argument is NOT case-sensitive. |
|{{{View}}} | Yes | acViewDesign<br />acViewNormal<br />acViewPreview |The view in which the query will open.<br />//acViewNormal// and //acViewPreview// are equivalent. Default is //acViewNormal//. |
|{{{DataMode}}} |~| acEdit |The user will be allowed to add new records and edit existing records. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acViewDesign = 1
Global Const acViewNormal = 0
Global Const acViewPreview = 2
Global Const acEdit = 1
//}}}
!!!Remarks
If the //view// argument is //acDesign//, the query will get opened in Design mode. However any further action is not supported by the ~Access2Base API.
!!!Error messages
|Query '...' could not be opened |
|Query '...' not found |
!!!See also
[[Close]]
[[OpenForm]]
[[OpenReport]]
[[OpenTable]]
!!!Example
//{{{
OpenQuery("myQuery", acViewNormal)
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //~OpenReport// [[action|Actions]] opens a report in normal view or in report design view.
!!!Syntax
{{{OpenReport(}}}//{{{ReportName, View}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{ReportName}}} | No | String |The name of the report to open. This argument is NOT case-sensitive. |
|{{{View}}} | Yes | acViewDesign<br />acViewNormal<br />acViewPreview |The view in which the query will open.<br />//acViewNormal// and //acViewPreview// are equivalent. Default is //acViewNormal//. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acViewDesign = 1
Global Const acViewNormal = 0
Global Const acViewPreview = 2
//}}}
!!!Remarks
*If the report was built with the Sun Report Builder extension, this extension is required to get the report open.
*If the //view// argument is //acDesign//, the query will get opened in Design mode. However any further action is not supported by the ~Access2Base API.
!!!Error messages
|Report '...' could not be opened |
|Report '...' not found |
!!!See also
[[Close]]
[[OpenForm]]
[[OpenQuery]]
[[OpenTable]]
!!!Example
//{{{
OpenQuery("myQuery", acViewNormal)
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //~OpenTable// [[action|Actions]] opens a table in normal view or in table design view.
!!!Syntax
{{{OpenTable(}}}//{{{TableName, View, DataMode}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{TableName}}} | No | String |The name of the table to open. This argument is NOT case-sensitive. |
|{{{View}}} | Yes | acViewDesign<br />acViewNormal<br />acViewPreview |The view in which the table will open.<br />//acViewNormal// and //acViewPreview// are equivalent. Default is //acViewNormal//. |
|{{{DataMode}}} |~| acEdit |The user will be allowed to add new records and edit existing records. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acViewDesign = 1
Global Const acViewNormal = 0
Global Const acViewPreview = 2
Global Const acEdit = 1
//}}}
!!!Remarks
If the //view// argument is //acDesign//, the table will get opened in Design mode. However any further action is not supported by the ~Access2Base API.
!!!Error messages
|Table '...' could not be opened |
|Table '...' not found |
!!!See also
[[Close]]
[[OpenForm]]
[[OpenQuery]]
[[OpenReport]]
!!!Example
//{{{
OpenTable("myTable", acViewNormal)
//}}}
//{{{
Sub DBOpen(Optional poEvent As Object)
If GlobalScope.BasicLibraries.hasByName("Access2Base") then _
GlobalScope.BasicLibraries.LoadLibrary("Access2Base")
Call OpenConnection(ThisDatabaseDocument)
End Sub
//}}}
Open a form
//{{{
OpenForm "myForm"
//}}}
Open a form in read only mode
//{{{
OpenForm "myForm", , , , acFormReadOnly
//}}}
Open a form in read only mode. The form must be hidden.
//{{{
Dim ofForm As Object
ofForm = OpenForm "myForm", , , , acFormReadOnly, acHidden
//}}}
Make it later visible
//{{{
ofForm.Visible = True
//}}}
{{firstletter{
@@color:#930;A@@
}}}n //~OptionGroup// [[object|Object Model]] represents a set of [[RadioButton]] controls in a [[form|Form]] or a [[subform|SubForm]], having the same __name__. It is the identical names of the //radiobuttons// which makes them bound in the sense that selecting one button deselects automatically all the others.
Most properties can be set at //~RadioButton// level and individually for each of them. However the key reason for having introduced //~OptionGroups// (an artificial entity with no equivalent in //~OpenOffice/~LibreOffice//) in //~Access2Base// is giving the programmer an easy mean to determine which //~RadioButton// s currently selected.
!!!Function returning an ~OptionGroup object
| !Method | !Applied to | !Arg |!Description |
|[[OptionGroup|OptionGroup (Method)]] | [[Form]]<br />[[SubForm]] | String |Returns an //~OptionGroup// object in the form or subform on which the method is applied having Arg as name. The name is the common name of all //radio buttons// belonging to the ~OptionGroup.|
!!!Properties
| !Property | !Read only | !Description or UNO object |
|[[Name]] | Y |Specifies the exact name of the option group. |
|[[Count]] | Y |Specifies the number of radio buttons belonging to the group. |
|[[ObjectType]] | Y |Returns "OPTIONGROUP" |
|[[Value]] ||Specifies the index of the radio button being currently selected. |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the ~OptionGroup has the given property. |
!!!Remarks
The //Value// property holds a value between 0 and //Count// - 1.
!!!See also
[[Controls]]
[[OptionGroup (Method)]]
[[RadioButton]]
!!!Example
<<tiddler "Optiongroup example">>
The //~OptionGroup// method returns an [[object|Object Model]] of type [[OptionGroup]]
!!!Syntax
//form//.{{{OptionGroup(}}}//groupname//{{{)}}}
//subform//.{{{OptionGroup(}}}//groupname//{{{)}}}
| !Argument | !Type |!Returned value |
|form | [[Form]]<br />[[SubForm]] |An object of type //~OptionGroup// having the //groupname// as name. The name is that of all radio buttons sharing the same selection group. |
|groupname | string |~|
!!!Remarks
The individual //~RadioButtons// can be retrieved with the [[Controls]] method applied to the //~OptionGroup// object. Use their //index// as second argument. The //index// is determined by the ~X-Y coordinates of the //~RadioButton// on the screen.
!!!See also
[[Controls]]
[[OptionGroup]]
[[RadioButton]]
!!!Example
<<tiddler "Optiongroup example">>
The //~OptionValue// property specifies the value stored in the database as determined by the selected [[RadioButton]].
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[RadioButton]] | None |A control on an open form. |
!!!Syntax
//control//{{{.OptionValue}}}
!!!Returned value
{{{String}}}
!!!Remarks
The //~OptionValue// property is read-only.
!!!Error messages
!!!See also
[[RadioButton]]
[[OptionGroup]]
!!!Example
<<tiddler "OptionValue example">>
Browse thru the values to store in the database by button
//{{{
Dim ofForm As Object, ocOptionGroup As Object, ocControl As Object, i as integer
Set ofForm = Forms("myform")
Set ocOptionGroup = ofForm.OptionGroup("myRadioButton")
ocOptionGroup.Value = 2
For i = 0 to ocOptionGroup.Count - 1
ocControl = ocOptionGroup.Controls(i)
Print ocControl.OptionValue & "/",
Next i
//}}}
Change the currently selected radio button and modify its appearance
//{{{
Dim ofForm As Object, ocOptionGroup As Object, ocControl As Object, i as integer
Set ofForm = Forms("myform")
Set ocOptionGroup = ofForm.OptionGroup("myRadioButton")
ocOptionGroup.Value = 2
For i = 0 to ocOptionGroup.Count - 1
ocControl = ocOptionGroup.Controls(i)
If i = ocOptionGroup.Value Then
ocControl.ForeColor = RGB(255, 0 ,0)
Else
ocControl.ForeColor = RGB(0, 0 ,0)
End If
Next i
//}}}
*Order Details table
| !Fields | !Field Type | !Primary |
|Discount | Text ||
|~OrderID | ~BigInt | Y |
|~ProductID | ~BigInt | Y |
|Quantity | Integer ||
|~UnitPrice | Number ||
*Orders table
| !Fields | !Field Type | !Primary |
|~CustomerID | Text ||
|~EmployeeID | Integer ||
|Freight | Number ||
|~OrderDate | Date/Time ||
|~OrderID | ~BigInt | Y |
|~RequiredDate | Date/Time ||
|~ShipAddress | Text ||
|~ShipCity | Text ||
|~ShipCountry | Text ||
|~ShipName | Text ||
|~ShippedDate | Date/Time ||
|~ShipPostalCode | Text ||
|~ShipRegion | Text ||
|~ShipVia | Integer ||
{{firstletter{
@@color:#930;T@@
}}}he //~OutputTo// [[action|Actions]] outputs the data in the specified object (currently only a form) to several output formats.
!!!Syntax
{{{OutputTo(}}}//{{{ObjectType, ObjectName, OutputFormat, OutputFile, AutoStart, TemplateFile, Encoding}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description | !Returned value |
|{{{ObjectType}}} | No | acOutputForm |The type of object to output.<br />The only accepted value is {{{acOutputForm}}}. | {{{True}}} if success |
|{{{ObjectName}}} | Yes | String |The valid name of an object of the type selected by the //~ObjectType// argument. If you want to output the active object, specify the object's type for the ~ObjectType argument and leave this argument blank. |~|
|{{{OutputFormat}}} | Yes | acFormatPDF<br />acFormatODT<br />acFormatDOC<br />acFormatHTML |The output format, expressed as an acFormatXXX constant. If this argument is omitted, te user will be prompted for the output format. |~|
|{{{OutputFile}}} | Yes | String |The full name, including the path, of the file you want to output the object to. If this argument is left blank, the user will be prompted for an output file name. |~|
|{{{AutoStart}}} | Yes | Boolean |If {{{True}}}, specifies that you want the appropriate software to start immediately after the //~OutputTo// action runs, with the file specified by the //~OutputFile// argument opened. |~|
|{{{TemplateFile}}} | Yes | String |If present, must be a null-length string. |~|
|{{{Encoding}}} | Yes | String |If present, must be a null-length string. |~|
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acOutputForm = 2
Global Const acFormatPDF = "writer_pdf_Export"
Global Const acFormatODT = "writer8"
Global Const acFormatDOC = "MS Word 97"
Global Const acFormatHTML = "HTML"
//}}}
!!!Remarks
*The designated form MUST be open before the //~OutputTo// action is called.
*If the {{{OutputFile}}} argument is not equal to space, and If the output file already exists, it will be overwritten without warning. If the user is prompted for the output file ({{{OutputFile}}} = space), the user will be requested to confirm the Save.
*The {{{OutputFile}}} argument may be expressed either in the (recommended) URL format (i.e. "{{{file:// ...}}}") or by using the operating system usual syntax (e.g. "{{{C:\...}}}" in Windows).
!!!Error messages
|Object '...' not found |
|Action not applicable in this context |
!!!See also
[[RunApp]]
[[SelectObject]]
[[SendObject]]
!!!Example
<<tiddler "OutputTo example">>
Output form in PDF format to a file (you will be prompted for the file name and location) and open the generated file (asynchronously)
//{{{
Const acOutputForm = 2
Const acFormatPDF = "writer_pdf_Export"
OutputTo(acOutputForm, "myform", acFormatPDF,, True)
//}}}
<!--{{{-->
<div class='header'>
<div class='titleLine'>
<span class='siteTitle' refresh='content' tiddler='SiteTitle'></span>
<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'></span>
</div>
</div>
<div id='mainMenu' refresh='content' tiddler='MainMenu'></div>
<div id='sidebar'>
<div macro='gradient vert #ffffff #cc9900'><a> </a><div id='sidebarOptions' refresh='content' tiddler='SideBarOptions'></div>
</div>
<div id='sidebarTabs' refresh='content' force='true' tiddler='SideBarTabs'></div>
</div>
<div id='displayArea'>
<div id='messageArea'></div>
<div id='tiddlersBar' refresh='none' ondblclick='config.macros.tiddlersBar.onTiddlersBarAction(event)'></div>
<div id='tiddlerDisplay'></div>
</div>
<!--}}}-->
The //Parent// property returns the parent object of a [[Control]] or of a [[SubForm]].
!!!Applies to ...
| !Object |!Description |
|[[SubForm]] |A subform of an open form |
|[[Control]] |A control of an open form |
!!!Syntax
//subform//{{{.Parent}}}
//control//{{{.Parent}}}
!!!Returned values
{{{Object}}}
!!!Remarks
*The Parent property is read-only.
*The parent can be itself an object of type [[Control]], [[SubForm]] or [[Form]].
!!!Error messages
!!!Example
<<tiddler "Parent example">>
Browse objects tree upwards
//{{{
Dim oSomeObject As Object
Set oSomeObject = getObject("Forms!Invoice!SubForm.Form!SubForm_Grid![SeqNr Invoice]")
While Not IsNull(oSomeObject)
Print oSomeObject.Name,
Set oSomeObject = oSomeObject.Parent
Wend
//}}}
*Products table
| !Fields | !Field Type | !Primary |
|~CategoryID | ~BigInt ||
|~ProductName | Text ||
|~QuantityPerUnit | Text ||
|~ReorderLevel | Integer ||
|~SupplierID | ~BigInt ||
|~UnitPrice | Number ||
|~UnitsInStock | Integer ||
|~UnitsOnOrder | Integer ||
|Discontinued | Boolean ||
|~ProductID | ~BigInt | Y |
|Picture | Image ||
The //Properties// collection describes instances of all __properties__ of an [[object|Object Model]]
!!!Syntax
//object//.{{{Properties()}}}
//object//.{{{Properties(index)}}} or //object//.{{{Properties(propertyname)}}}
| !Argument | !Type |!Returned value |
|| absent |A [[Collection]] of the properties of the object |
| index | integer<br />long |A [[property|Property]] object |
| propertyname | string |~|
!!!Remarks
*Property [[collections|Collection]] are numbered from 0 to //object//.{{{Properties(...).Count - 1}}}
*The //propertyname// argument is not case sensitive.
!!!Error messages
|Argument nr.1 is invalid |
|Out of array range or incorrect array size for collection Properties() |
!!!See also
[[Property]]
[[hasProperty]]
[[getProperty]]
[[setProperty]]
!!!Examples
<<tiddler "Properties example">>
To list the value of each property of a form ...
//{{{
Dim ofForm As Object, i As Integer, iCount As Integer, oProperty As Object
Set ofForm = Forms("myForm")
iCount = getCount(Properties(ofForm))
For i = 0 To iCount - 1
oProperty = Properties(ofForm, i)
Print getName(oProperty) & "=" & getValue(oProperty),
Next i
Print
//}}}
The {{{Property}}} [[object|Object Model]] describes a ~Name-Value pair of any property of any other object.
!!!Functions returning a property object
| !Function | !Type |!Description |
|[[Properties]] | [[Collection]] |//object//.{{{Properties(}}}//property-name//{{{)}}} returns a //Property// object. |
!!!Properties of the returned object
| !Property | !Type | !Description |
|[[Name]] | String ||
|[[ObjectType]] | String |Returns "PROPERTY" |
|[[Value]] | Variant |The value of the considered property (might be an array). |
!!!Syntax
//property//{{{.Name}}}
//property//{{{.Value}}}
!!!Remarks
*All properties of a //Property// object are read-only.
!!!See also
[[Properties]]
[[hasProperty]]
[[getProperty]]
[[setProperty]]
!!!Example
<<tiddler "Properties example">>
{{firstletter{
@@color:#930;T@@
}}}he //Quit// [[action|Actions]] quits //~OpenOffice/~LibreOffice Base//. You can select one of several options for saving a database object before quitting.
!!!Syntax
{{{Quit(}}}//{{{Option}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description |
|{{{Option}}} | Yes | acQuitPrompt, acQuitSaveAll, acQuitSaveNone |//acQuitPrompt// Displays a dialog box that asks whether you want really to quit or not.<br />//acQuitSaveAll// (default) Saves all objects without displaying a dialog box.<br />//acQuitSaveNone// Quits without saving any objects. |
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acQuitPrompt = 0
Global Const acQuitSaveAll = 1
Global Const acQuitSaveNone = 2
//}}}
!!!Remarks
The Quit method has the same effect as clicking Exit on the File menu in the //~OpenOffice/~LibreOffice Base// window.
!!!Error messages
!!!See also
!!!Example
Display next message box: ''Do you really want to quit the application ? Changed data will be saved.''
If Yes pressed, the application will close.
//{{{
Quit(acQuitPrompt)
//}}}
{{firstletter{
@@color:#930;A@@
}}} //~RadioButton// [[control|Control]] enables the user to choose among one of several options. Radio buttons grouped in the sense that selecting one deselects all the others are given the same name (Name property). usually, they are grouped in a group box.
!!!Specific properties of radio buttons
| !Property | !Read only | !Description |
|[[Name]] | Y |Specifies the exact name of all the radio buttons sharing the same [[OptionGroup]]. |
|[[OptionValue]] | Y |Specifies the value that is stored in the database when the radio button is selected and the record saved. |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the ~RadioButton has the given property. |
!!!Remarks
The ~RadioButton control has no //Value// property.
To identify the selected radio button, use the [[OptionGroup|OptionGroup (Method)]] method and the [[Value]] property of the returned [[OptionGroup]] object.
!!!See also
[[OptionGroup (Method)]]
[[OptionGroup]]
!!!Example
<<tiddler "Optiongroup example">>
You can use the //~RecordSource// property to specify the source of the data displayed in a form.
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
|[[SubForm]] |The subform of an open form |
!!!Syntax
//form//{{{.RecordSource}}}
//form//{{{.RecordSource}}} = //value//
//subform//{{{.RecordSource}}}
//subform//{{{.RecordSource}}} = //value//
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
The //~RecordSource// property is a string expression consisting of either
*a table name
*a query name
*a SQL statement including the SELECT verb
However to modify the ~RecordSource property, use __only a SQL statement__. When the ~RecordSource property value is changed, the //form// or //subform// is reloaded automatically.
After modification of the //~RecordSource// any preexisting filter on the form is reset.
!!!Error messages
|Form '...' is currently not open |
|Value '...' is invalid for property '~RecordSource' |
!!!See also
[[ControlSource]]
[[Requery]]
!!!Example
<<tiddler "RecordSource example">>
Set new data source on open form
//{{{
Dim ofForm As Object, sSQL As String
ofForm = Forms("myForm")
sSQL = "SELECT * FROM [EMPLOYEE] WHERE " _
& "[EMPLOYEE].[NAME] LIKE '*MICKEY*' Or [EMPLOYEE].[NAME] LIKE '*WINNIE*'"
ofForm.RecordSource = sSQL
//}}}
The //Refresh// method immediately updates the records in the underlying record source for a specified form to reflect changes made to the data by you or other users in a multiuser environment.
!!!Applies to ...
| !Object | !Description |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice Base// database form. |
|[[SubForm]] |A subset of the [[Controls|Control]] present in a Form. |
!!!Syntax
//form.//{{{Refresh}}}
//subform.//{{{Refresh}}}
!!!Remarks
!!!Error messages
!!!See also
[[RecordSource]]
[[Requery]]
!!!Example
<<tiddler "Refresh example">>
Refresh the data in the current record of a form
//{{{
Dim ofForm As Object
Set ofForm = Forms("myForm")
ofForm.Refresh
//}}}
| !Release | !Date | !Description |
| 0.9.0 | 01/2013 |Complete internal redesign of code to allow more object-oriented syntaxes for property settings and method invocations.<br />E.g.<br />{{{form.height = 100}}}<br />{{{form.move(100,200)}}}<br />Old syntax still supported.<br />Consolidation of the object model with the [[Parent]], [[Source|Event]] and [[ObjectType]] properties.<br />Addition of a [[Close|Close (method)]] method to the //Form// object.<br />Several bugs corrections. |
| 0.8.9 | 10/2012 |Localization:<br />- of the 2 dialogs forms<br />- of all strings (mainly error messages) used in the API<br />A french translation is provided.<br />For other languages, contributions are welcome. See [[Contact]]. |
| 0.8.6 | 09/2012 |Maintenance release. |
| 0.8.5 | 08/2012 |Introduction of new commands:<br />[[OutputTo]] for storing a form document as a PDF, DOC, ... file.<br />[[SendObject]] to send a form after transformation to PDF, DOC, ... by mail.<br />[[RunApp]] to start an external application. |
| 0.8.2 | 08/2012 |API implementation identical to 0.8.1<br />"Check for Updates ..." functionality of AAO/~LibO now detects ~Access2Base new versions. |
| 0.8.1 | 08/2012 |Maintenance release (bug in setValue method). |
| 0.8.0 | 07/2012 |Full support of [[standalone (Writer) forms|Standalone Forms]].<br />[[RadioButtons|RadioButton]] order is now determined by their ~X-Y coordinates on the screen.<br />Bug fixing in [[checkboxes controls|Control]] when linked to a database field.<br /> Support of "Currency" datatype in arguments to the API. Useful for controls of currency type. Converted to Double in internal processing. |
| 0.7.5 | 05/2012 |Support of [[Listboxes|ListBox]] with a separate column for bound fields.<br />Introduction of the [[Bookmark]] property of [[Form]] pseudo-objects.<br />New actions: [[ShowAllRecords]] and [[GoToControl]].<br />New methods for managing Listboxes content (with the //~ValueList// rowsource type): [[AddItem]] and [[RemoveItem]].<br />The [[RunSQL]] command accepts square brackets to surround field or table names. |
| 0.7.1 | 04/2012 |Correction of URL of online help. Clickable from Help menu in the Basic IDE. |
| 0.7.0 | 04/2012 |Bugs fixing in the [[SelectObject]] action (abort when help file open).<br />Extension of the scope of the [[SelectObject]] action.<br />Introduction of the [[RunCommand]] action. Documentation updated. |
| 0.6.0 | 04/2012 |New actions [[SelectObject]], [[Minimize]], [[Maximize]] and [[MoveSize]]<br />"~Access2Base Help" menu command in IDE opens Online help on [[www.access2base.com|http://www.access2base.com]]. |
| 0.5.1 | 03/2012 |"Out of array range" error message added for collections (i.o. "Invalid parameter"). |
| 0.5.0 | 03/2012 |First public release. |
The //~RemoveItem// method removes an item from the list of values displayed by the specified list box control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ListBox]] | [[ListBox]] |A listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.RemoveItem(}}}//index//{{{)}}}
| !Argument | !Type | !Description |
| index | Integer<br />Long |The position in the list of the item to remove. |
|~| String |The value of the item to remove. The comparison with the actual values in the list is case-sensitive. |
!!!Remarks
*The [[RowSourceType]] property of the concerned //~ListBox// must contain the value {{{com.sun.star.form.ListSourceType.VALUELIST}}}.
*Combo boxes do not support this value. That's why //~RemoveItem// is applicable only on listboxes.
*List item numbers start from zero. If the value of the {{{index}}} argument doesn't correspond to an existing item number, an error occurs.
*//~RemoveItem// returns True if success, False otherwise. False is returned if {{{index}}} is a string and the string has not been found in the listbox.
!!!Error messages
|Argument nr. X is invalid |
|Method not applicable in this context |
!!!See also
[[ListBox]]
[[AddItem]]
[[RowSource]]
[[RowSourceType]]
!!!Example
<<tiddler "Addremoveitem example">>
The //Requery// method updates the data underlying a specified control that's on the active form by requerying the source of data for the control.
If the target is a [[Form]] and the source is a //Parameter Query// the parameters are re-asked to the user.
!!!Applies to ...
| !Object | !Description |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice Base// database form. |
|[[SubForm]] |A subset of the [[Controls|Control]] present in a Form. |
|[[ComboBox]] |A combobox control. |
|[[ListBox]] |A listbox control. |
!!!Syntax
//form.//{{{Requery}}}
//subform.//{{{Requery}}}
//control.//{{{Requery}}}
!!!Remarks
If the targeted object is a Form or a ~SubForm the //Requery// method resets the current record to the first available in the record set.
!!!Error messages
!!!See also
[[RecordSource]]
[[Refresh]]
[[RowSource]]
!!!Example
<<tiddler "Requery example">>
Reload the content of a combo box after a database change
//{{{
Dim ofForm As Object, ocCombo As Object
Set ofForm = Forms("myForm")
Set ocCombo = ofForm.Controls("myComboBox")
ocCombo.Requery
//}}}
The //Required// property specifies whether a control must contain a value when the record is edited.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |~CheckBox<br />[[ComboBox]]<br />~CurrencyField<br />~DateField<br />~FormattedField<br />~ImageControl<br />[[ListBox]]<br />~NumericField<br />~PatternField<br />[[RadioButton]]<br />~TextField<br />~TimeField | All |A control on an open form or within a [[GridControl]] of one of the listed types |
!!!Syntax
//control//{{{.Required}}}
//control//{{{.Required}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property 'Required' not applicable in this context |
|Value '...' is invalid for property 'Required' |
!!!Example
<<tiddler "Required example">>
Force value in field to avoid error on Null value when saving record (e.g. in When Loading form event)
{{{
Dim ocControl As Object
Set ocControl = Controls("myForm", "myFormattedField")
ocControl.Required = True
}}}
You can use the //~RowSource// property (along with the [[RowSourceType]] property) to tell ~OpenOffice/~LibreOffice Base how to provide data to a list box or to a combo box.
!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ComboBox]]<br />[[ListBox]] | [[ComboBox]]<br />[[ListBox]] |A combo- or listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.RowSource}}}
//control//{{{.RowSource}}} = //value//
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
The //value// argument must contain, depending on the value of the [[RowSourceType]] property, either
*the exact name of a table or a query,
*or a correct SQL SELECT statement
*or a list of values separated by a semicolon (";") bundled in one single string.
When the //~RowSource// property is changed the content of the combo- or listbox is refreshed.
!!!Error messages
|Property '~RowSource' not applicable in this context |
|Value '...' is invalid for property '~RowSource' |
!!!See also
[[ItemData]]
[[ListCount]]
[[ListIndex]]
[[MultiSelect]]
[[Requery]]
[[RowSourceType]]
[[Selected]]
!!!Example
<<tiddler "RowSource example">>
Modify the content of a combo and a listbox
Select first item in the combobox
Select all tems in the listbox
//{{{
Dim ocCombo As Object, ocList As Object
Set ocCombo = getObject("Forms!myForm!myComboBox")
ocCombo.RowSourceType = com.sun.star.form.ListSourceType.SQL
ocCombo.RowSource = "SELECT [SHORTNAME] FROM COMPANIES WHERE [SHORTNAME]<>'' ORDER BY [SHORTNAME]"
ocCombo.ListIndex = 0
Set ocList = getObject("Forms!myForm!myListBox")
ocList.RowSourceType = com.sun.star.form.ListSourceType.VALUELIST
ocList.RowSource = "First;Second;Third"
ocList.Selected = Array(True, True, True)
//}}}
You can use the //~RowSourceType// property (along with the [[RowSource]] property) to tell ~OpenOffice/~LibreOffice Base how to provide data to a list box or to a combo box.
!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ComboBox]]<br />[[ListBox]] | [[ComboBox]]<br />[[ListBox]] |A combo- or listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.RowSourceType}}}
//control//{{{.RowSourceType}}} = //value//
!!!Returned values / Arguments
{{{Integer}}}
!!!Remarks
The //value// argument must contain, depending on the value of the [[RowSource]] property, one of next symbolic values:
|com.sun.star.form.~ListSourceType.VALUELIST |A //~ComboBox// control does not support this value for the //~RowSourceType// property. |
|com.sun.star.form.~ListSourceType.TABLE ||
|com.sun.star.form.~ListSourceType.QUERY |~|
|com.sun.star.form.~ListSourceType.SQL |~|
|com.sun.star.form.~ListSourceType.SQLPASSTHROUGH |~|
|com.sun.star.form.~ListSourceType.TABLEFIELDS |~|
See the [[OpenOffice documentation|http://api.openoffice.org/docs/common/ref/com/sun/star/form/component/DatabaseListBox.html#ListSourceType]] for more details.
When the //~RowSourceType// property is changed the content of the combo- or listbox is ''NOT'' refreshed.
!!!Error messages
|Property '~RowSourceType' not applicable in this context |
|Value '...' is invalid for property '~RowSourceType' |
!!!See also
[[ItemData]]
[[ListCount]]
[[ListIndex]]
[[MultiSelect]]
[[Requery]]
[[RowSource]]
[[Selected]]
!!!Example
<<tiddler "RowSource example">>
{{firstletter{
@@color:#930;T@@
}}}he //~RunApp// [[action|Actions]] runs an external application given by its command line. The command line may be an executable file or a user file associated via its suffix with an executable application.<br />Use caution when running executable files or code in macros or applications. Executable files or code can be used to carry out actions that might compromise the security of your computer and data.
!!!Syntax
{{{Call RunApp(}}}//{{{CommandLine}}}//{{{)}}}
| !Argument | !Optional | !Type |!Description | !Returned value |
|{{{CommandLine}}} | No | String |The command line used to start the application<br />(including the path and any other necessary parameters, such as switches that run the application in a particular mode). | No return. {{{RunApp}}} is a Sub. |
!!!Remarks
*The application selected with this action loads and runs in the foreground. The macro containing this action continues to run after starting the application.
*The {{{CommandLine}}} argument may be expressed either in the (recommended) URL format (i.e. "{{{file:// ...}}}") or by using the operating system usual syntax (e.g. "{{{C:\...}}}" in Windows).
*Note that Basic provides an equivalent standard function {{{Shell}}}. It provides even more options. //~RunApp// is proposed here to improve compatibility with Visual Basic.
!!!Error messages
None
!!!See also
[[OutputTo]]
!!!Example
<<tiddler "RunApp example">>
To open a PDF file
//{{{
RunApp("C:\Users\MyName\Documents\Doc\Basic\OOBasic FormsAndDialogs.pdf") ' Valid only in Windows
//}}}
The absence of Macro Recorder in AOO/~LibO Base and the lack of documentation makes the use of the numerous commands available in the software very difficult. The current help page tries to compensate partially this handicap.
The //~RunCommand// [[action|Actions]] executes the command given as argument.
Combined with the [[SelectObject]] action it enhances significantly the automation capabilities of applications using the //~Access2Base// API.
!!!Syntax
{{{RunCommand(}}}//{{{Command}}}//{{{)}}}
| !Argument | !Optional | !Type |!Description | !Returned Value |
| Command | No | String<br />Integer, Long |If numeric the Command is selected by using the VBA denomination. If the Type is a String, the AOO/~LibO command-name is expected | Always returns True |
!!!Commands List
| !AOO/~LibO Command | !VBA Equivalent | !Context(s) |!Short description |
|"About" |acCmdAboutMicrosoftAccess | Any |About ~OpenOffice.org/~LibreOffice |
|~|acCmdAboutOpenOffice | Any |About ~OpenOffice.org/~LibreOffice |
|~|acCmdAboutLibreOffice | Any |About ~OpenOffice.org/~LibreOffice |
|"~ActiveHelp" || Any |Extended Tips |
|"~AddDirect" || Any |New |
|"~AddField" || acForm (Design mode) |Add Field |
|"~AutoControlFocus" || acForm (Design mode) |Automatic Control Focus |
|"~AutoFilter" || acTable |~AutoFilter |
|"~AutoPilotAddressDataSource" || Any |~AutoPilot: Address Data Source |
|"~BasicBreak" || Any |Interrupt Macro |
|"~BasicIDEAppear" |acCmdVisualBasicEditor | Any |Edit Macros |
|"~BasicStop" || acBasicIDE |Stop Macro |
|"~BringToFront" |acCmdBringToFront | Any |Bring to Front |
|"~CheckBox" || acForm (Design mode) |Check Box |
|"~ChooseMacro" || acBasicIDE |Select Macro |
|"~CloseDoc" |acCmdClose | Any |Close |
|"~CloseWin" || Any |Close Window |
|"~ConfigureDialog" |acCmdToolbarsCustomize | Any |Customize |
|"~ControlProperties" || Controls |Control |
|"~ConvertToButton" |acCmdChangeToCommandButton | Controls |Replace with Button |
|"~ConvertToCheckBox" |acCmdChangeToCheckBox | Controls |Replace with Check Box |
|"~ConvertToCombo" |acCmdChangeToComboBox | Controls |Replace with Combo Box |
|"~ConvertToCurrency" || Controls |Replace with Currency Field |
|"~ConvertToDate" || Controls |Replace with Date Field |
|"~ConvertToEdit" |acCmdChangeToTextBox | Controls |Replace with Text Box |
|"~ConvertToFileControl" || Controls |Replace with File Selection |
|"~ConvertToFixed" |acCmdChangeToLabel | Controls |Replace with Label Field |
|"~ConvertToFormatted" || Controls |Replace with Formatted Field |
|"~ConvertToGroup" || Controls |Replace with Group Box |
|"~ConvertToImageBtn" || Controls |Replace with Image Button |
|"~ConvertToImageControl" |acCmdChangeToImage | Controls |Replace with Image Control |
|"~ConvertToList" |acCmdChangeToListBox | Controls |Replace with List Box |
|"~ConvertToNavigationBar" || Controls |Replace with Navigation Bar |
|"~ConvertToNumeric" || Controls |Replace with Numerical Field |
|"~ConvertToPattern" || Controls |Replace with Pattern Field |
|"~ConvertToRadio" |acCmdChangeToOptionButton | Controls |Replace with Radio Button |
|"~ConvertToScrollBar" || Controls |Replace with Scrollbar |
|"~ConvertToSpinButton" || Controls |Replace with Spin Button |
|"~ConvertToTime" || Controls |Replace with Time Field |
|"Copy" |acCmdCopy | Any |Copy |
|"~CurrencyField" || acForm (Design mode) |Currency Field |
|"Cut" |acCmdCut | Any |Cut |
|"~DateField" || acForm (Design mode) |Date Field |
|"~DBAddRelation" |acCmdCreateRelationship | acDiagram |New Relation ... |
|"~DBConvertToView" || acDatabaseWindow (Queries) |Create as View |
|"~DBDelete" |acCmdDelete | acDatabaseWindow |Delete |
|"~DBDirectSQL" || acDatabaseWindow |SQL ... |
|"~DBDSAdvancedSettings" || acDatabaseWindow |Advanced Settings ... |
|"~DBDSConnectionType" || acDatabaseWindow |Connection Type ... |
|"~DBDSProperties" |acCmdDatabaseProperties | acDatabaseWindow |Properties ... |
|"~DBEdit" || acDatabaseWindow |Edit ... |
|"~DBEditSqlView" |acCmdSQLView | acDatabaseWindow (Queries) |Edit in SQL View ... |
|"~DBFormDelete" |acCmdRemove | acDatabaseWindow (Forms) |Delete |
|"~DBFormEdit" |acCmdDesignView | acDatabaseWindow (Forms) |Edit ... |
|"~DBFormOpen" |acCmdFormView | acDatabaseWindow (Forms) |Open Database Object ... |
|"~DBFormRename" || acDatabaseWindow (Forms) |Rename ... |
|"~DBNewForm" |acCmdNewObjectForm | acDatabaseWindow (Forms) |Form ... |
|"~DBNewFormAutoPilot" || acDatabaseWindow (Forms) |Form Wizard ... |
|"~DBNewQuery" || acDatabaseWindow (Queries) |Query (Design View) ... |
|"~DBNewQueryAutoPilot" || acDatabaseWindow (Queries) |Query Wizard ... |
|"~DBNewQuerySql" || acDatabaseWindow (Queries) |Query (SQL View) ... |
|"~DBNewReport" || acDatabaseWindow (Reports) |Report ... |
|"~DBNewReportAutoPilot" || acDatabaseWindow (Reports) |Report Wizard ... |
|"~DBNewTable" |acCmdNewObjectTable | acDatabaseWindow (Tables) |Table Design ... |
|"~DBNewTableAutoPilot" || acDatabaseWindow (Tables) |Table Wizard ... |
|"~DBNewView" |acCmdNewObjectView | acDatabaseWindow (Tables) |View Design ... |
|"~DBNewViewSQL" || acDatabaseWindow (Tables) |View (Simple) ... |
|"~DBOpen" |acCmdOpenDatabase | acDatabaseWindow |Open Database Object ... |
|"~DBQueryDelete" |acCmdRemove | acDatabaseWindow (Queries) |Delete |
|"~DBQueryEdit" |acCmdDesignView | acDatabaseWindow (Queries) |Edit ... |
|"~DBQueryOpen" |acCmdNewObjectQuery | acDatabaseWindow (Queries) |Open Database Object ... |
|"~DBQueryRename" || acDatabaseWindow (Queries) |Rename ... |
|"~DBRefreshTables" || acDatabaseWindow |Refresh Tables |
|"~DBRelationDesign" |acCmdShowAllRelationships | acDatabaseWindow |Relationships ... |
|"~DBRename" || acDatabaseWindow |Rename ... |
|"~DBReportDelete" |acCmdRemove | acDatabaseWindow (Reports) |Delete |
|"~DBReportEdit" |acCmdDesignView | acDatabaseWindow (Reports) |Edit ... |
|"~DBReportOpen" |acCmdNewObjectReport | acDatabaseWindow (Reports) |Open Database Object ... |
|"~DBReportRename" || acDatabaseWindow (Reports) |Rename ... |
|"~DBSelectAll" |acCmdSelectAll | acDatabaseWindow |Select All |
|"~DBShowDocInfoPreview" || acDatabaseWindow |Document Information |
|"~DBShowDocPreview" || acDatabaseWindow |Document |
|"~DBTableDelete" |acCmdRemoveTable | acDatabaseWindow (Tables) |Delete |
|"~DBTableEdit" |acCmdDesignView | acDatabaseWindow (Tables) |Edit ... |
|"~DBTableFilter" || acDatabaseWindow (Tables) |Table Filter ... |
|"~DBTableOpen" |acCmdOpenTable | acDatabaseWindow (Tables) |Open Database Object ... |
|"~DBTableRename" |acCmdRename | acDatabaseWindow (Tables) |Rename ... |
|"~DBUserAdmin" || acDatabaseWindow |User Administration ... |
|"~DBViewForms" || acDatabaseWindow |Forms |
|"~DBViewQueries" || acDatabaseWindow |Queries |
|"~DBViewReports" || acDatabaseWindow |Reports |
|"~DBViewTables" || acDatabaseWindow |Tables |
|"Delete" |acCmdDelete | Any |Delete Contents |
|"~DeleteRecord" |acCmdDeleteRecord | acForm |Delete Record |
|"~DesignerDialog" || acForm (Design mode) |Styles and Formatting |
|"Edit" || acForm (Design mode) |Text Box |
|"~FirstRecord" || acForm |First Record |
|"~FontDialog" || acForm (Design mode) |Character |
|"~FontHeight" || acForm (Design mode) |Font Size |
|"~FormattedField" || acForm (Design mode) |Formatted Field |
|"~FormFilter" || acForm |~Form-Based Filters |
|"~FormFiltered" |acCmdApplyFilterSort | acForm |Apply Filter |
|"~FormFilterExecute" || acForm |Apply ~Form-Based Filter |
|"~FormFilterExit" || acForm |Close |
|"~FormFilterNavigator" || acForm |Filter Navigation |
|"~FormProperties" || acForm (Design mode) |Form |
|"~FullScreen" || acForm |Full Screen |
|"Gallery" || acForm |Gallery |
|"Grid" || acForm (Design mode) |Table Control |
|"~GridUse" |acCmdSnapToGrid | acForm (Design mode) |Snap to Grid |
|"~GridVisible" |acCmdViewGrid | acForm (Design mode) |Display Grid |
|"~GroupBox" || acForm (Design mode) |Group Box |
|"~HelpIndex" || Any |~OpenOffice.org Help |
|"~HelpSupport" || Any |Support |
|"~HyperlinkDialog" |acCmdInsertHyperlink | acForm (Design mode) |Hyperlink |
|"Imagebutton" || acForm (Design mode) |Image Button |
|"~ImageControl" || acForm (Design mode) |Image Control |
|"Label" || acForm (Design mode) |Label Field |
|"~LastRecord" |acCmdMaximumRecords | acForm |Last Record |
|"~ListBox" || acForm (Design mode) |List Box |
|"~MacroDialog" || Any |~OpenOffice.org Basic |
|"~MacroOrganizer" || Any |~OpenOffice.org Basic Macro Organizer |
|"~MoreControls" || acForm (Design mode) |More Controls |
|"~NavigationBar" || acForm (Design mode) |Navigation Bar |
|"Navigator" |acCmdObjectBrowser | acForm (Design mode) |Navigator |
|"~NewDoc" || Any |New Document From Template |
|"~NewRecord" || acForm |New Record |
|"~NextRecord" || acForm |Next Record |
|"~NumericField" || acForm (Design mode) |Numerical Field |
|"Open" || Any |Open |
|"~OptionsTreeDialog" || Any |Options |
|"Organizer" || Any |Organize |
|"~ParagraphDialog" || acForm (Design mode) |Paragraph |
|"Paste" |acCmdPaste | Any |Paste |
|"~PasteSpecial" |acCmdPasteSpecial | acForm (Design mode) |Paste Special ... |
|"~PatternField" || acForm (Design mode) |Pattern Field |
|"~PrevRecord" || acForm |Previous Record |
|"Print" |acCmdPrint | acForm, acReport (normal and design modes) |Print |
|"~PrintDefault" || acForm, acReport (normal and design modes) |Print File Directly |
|"~PrinterSetup" || acForm, acReport (normal and design modes) |Printer Settings |
|"~PrintPreview" |acCmdPrintPreview | acForm, acReport (normal and design modes) |Page Preview |
|"Pushbutton" || acForm (Design mode) |Push Button |
|"Quit" || acDatabaseWindow |Exit |
|"~RadioButton" || acForm (Design mode) |Option Button |
|"~RecSave" |acCmdSaveRecord | acForm |Save Record |
|"~RecSearch" |acCmdFind | acForm |Find Record |
|"~RecUndo" |acCmdUndo | acForm |Undo: Data entry |
|"Refresh" |acCmdRefresh | acForm, acTable, acQuery |Refresh |
|"Reload" || Any |Reload |
|"~RemoveFilterSort" |acCmdRemoveFilterSort | acForm |Remove Filter/Sort |
|"~RunMacro" |acCmdRunMacro | Any |Run Macro |
|"Save" |acCmdSave | Any |Save |
|"~SaveAll" || Any |Save All |
|"~SaveAs" |acCmdSaveAs | Any |Save As |
|"~SaveBasicAs" || acBasicIDE |Save BASIC |
|"~ScriptOrganizer" || Any |Organize Macros |
|"~ScrollBar" || acForm (Design mode) |Scrollbar |
|"~SearchDialog" |acCmdFind | acForm |Find & Replace |
|"~SelectAll" |acCmdSelectAll | Any |Select All |
|~|acCmdSelectAllRecords | Any |Select All |
|"~SendToBack" |acCmdSendToBack | Any |Send to Back |
|"~ShowFmExplorer" || acForm (Design mode) |Form Navigator |
|"~SortDown" |acCmdSortDescending | acForm, acTable, acQuery |Sort Descending |
|"Sortup" |acCmdSortAscending | acForm, acTable, acQuery |Sort Ascending |
|"~SpinButton" || acForm (Design mode) |Spin Button |
|"~StatusBarVisible" || Any |Status Bar |
|"~SwitchControlDesignMode" || acForm (Design mode) |Design Mode On/Off |
|"~TabDialog" |acCmdTabOrder | acForm (Design mode) |Activation Order |
|"~UseWizards" || acForm (Design mode) |Wizards On/Off |
|"~VersionDialog" || acForm (Design mode) |Versions |
|"~ViewDataSourceBrowser" || acForm |Data Sources |
|"~ViewFormAsGrid" |acCmdDatasheetView | acForm |Data source as Table |
|"Zoom" |acCmdZoomSelection | |Zoom |
The (VBA) symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acDiagram = 8
Global Const acForm = 2
Global Const acQuery = 1
Global Const acReport = 3
Global Const acTable = 0
Global Const acBasicIDE = 101
Global Const acDatabaseWindow = 102
//}}}
and, or ...
//{{{
Global Const acCmdAboutMicrosoftAccess = 35
Global Const acCmdAboutOpenOffice = 35
Global Const acCmdAboutLibreOffice = 35
Global Const acCmdVisualBasicEditor = 525
Global Const acCmdBringToFront = 52
Global Const acCmdClose = 58
Global Const acCmdToolbarsCustomize = 165
Global Const acCmdChangeToCommandButton = 501
Global Const acCmdChangeToCheckBox = 231
Global Const acCmdChangeToComboBox = 230
Global Const acCmdChangeToTextBox = 227
Global Const acCmdChangeToLabel = 228
Global Const acCmdChangeToImage = 234
Global Const acCmdChangeToListBox = 229
Global Const acCmdChangeToOptionButton = 233
Global Const acCmdCopy = 190
Global Const acCmdCut = 189
Global Const acCmdCreateRelationship = 150
Global Const acCmdDelete = 337
Global Const acCmdDatabaseProperties = 256
Global Const acCmdSQLView = 184
Global Const acCmdRemove = 366
Global Const acCmdDesignView = 183
Global Const acCmdFormView = 281
Global Const acCmdNewObjectForm = 136
Global Const acCmdNewObjectTable = 134
Global Const acCmdNewObjectView = 350
Global Const acCmdOpenDatabase = 25
Global Const acCmdRemove = 366
Global Const acCmdDesignView = 183
Global Const acCmdNewObjectQuery = 135
Global Const acCmdShowAllRelationships = 149
Global Const acCmdRemove = 366
Global Const acCmdDesignView = 183
Global Const acCmdNewObjectReport = 137
Global Const acCmdSelectAll = 333
Global Const acCmdRemoveTable = 84
Global Const acCmdDesignView = 183
Global Const acCmdOpenTable = 221
Global Const acCmdRename = 143
Global Const acCmdDelete = 337
Global Const acCmdDeleteRecord = 223
Global Const acCmdApplyFilterSort = 93
Global Const acCmdSnapToGrid = 62
Global Const acCmdViewGrid = 63
Global Const acCmdInsertHyperlink = 259
Global Const acCmdMaximumRecords = 508
Global Const acCmdObjectBrowser = 200
Global Const acCmdPaste = 191
Global Const acCmdPasteSpecial = 64
Global Const acCmdPrint = 340
Global Const acCmdPrintPreview = 54
Global Const acCmdSaveRecord = 97
Global Const acCmdFind = 30
Global Const acCmdUndo = 292
Global Const acCmdRefresh = 18
Global Const acCmdRemoveFilterSort = 144
Global Const acCmdRunMacro = 31
Global Const acCmdSave = 20
Global Const acCmdSaveAs = 21
Global Const acCmdFind = 30
Global Const acCmdSelectAll = 333
Global Const acCmdSelectAllRecords = 109
Global Const acCmdSendToBack = 53
Global Const acCmdSortDescending = 164
Global Const acCmdSortAscending = 163
Global Const acCmdTabOrder = 41
Global Const acCmdDatasheetView = 282
Global Const acCmdZoomSelection = 371
//}}}
!!!Remarks
*//~RunCommand// always returns //True//. If the argument does not exist, or if the request is not appropriate to the context, the action ignores the request.
*The Command argument, when of type String, is not case-sensitive.
*Above list of commands is not exhaustive. Other commands could succeed as well. However if the command to execute is not in the above list the argument MUST correspond exactly (... be properly cased as should ...) with the argument expected by a {{{executeDispatch()}}} UNO statement.
*The AOO/~LibO command and its VBA equivalent are //presumed// to be similar or equivalent. The ~RunCommand action always executes a AOO/~LibO command. There is no emulation of the VBA command.
*The //Context// column indicates one or more contexts in which the command has been tested and executed successfully. This does mean that other contexts could also allow a successful execution of the same command. When the context is __//Any//__ this only means that the command is likely to succeed in any context.
*The //~RunCommand// action is very often preceded by a [[SelectObject]] action to activate the correct context.
*Most commands open a dialog box. Today the AOO/~LibO documentation does not contain any indication about arguments that could bypass the dialog. The only ways to discover them are either to scan the software sources (what I did not do !) or to record the macro. But //AOO/~LibO Base// has no //Macro Recorder// (although Forms have ...!?) implemented.
!!!Error messages
|Arguments are missing or are not initialized |
!!!See also
[[SelectObject]]
!!!Examples
<<tiddler "RunCommand example">>
Open a form, and display it with its data source grid ...
//{{{
OpenForm("myForm")
RunCommand(acCmdDatasheetView) ' or RunCommand("ViewFormAsGrid")
//}}}
Next Sub linked to the "When loading" event ALWAYS opens a form with its datagrid ...
//{{{
Sub DisplayGrid(oEvent As Object)
RunCommand(acCmdDatasheetView)
End Sub
//}}}
To open a form in design mode with automatic display of Form properties ...
//{{{
OpenForm("myForm", acDesign)
RunCommand("FormProperties")
//}}}
To enter an SQL statement at any time, execute next code ...
//{{{
SelectObject(acDatabaseWindow)
RunCommand("DBDirectSQL")
//}}}
{{firstletter{
@@color:#930;T@@
}}}he //~RunSQL// [[action|Actions]] executes the SQL statement given as argument. The statement must execute an action. Examples of such statements are: INSERT INTO, DELETE, SELECT...INTO, UPDATE, CREATE TABLE, ALTER TABLE, DROP TABLE, CREATE INDEX, or DROP INDEX.
!!!Syntax
{{{RunSQL(SQL)}}}
| !Argument | !Optional | !Type |!Description |
|{{{SQL}}} | No | String |Specifies the statement to execute |
The action returns False if the execution of the SQL statement failed.
!!!Remarks
*RDBMS system commands can also be executed with {{{RunSQL}}}. E.g. next command, which is valid for an HSQLDB database, will close the database connection and compact the data contained in the database. See the respective RDBMS manuals for more details.
//{{{
SHUTDOWN COMPACT
//}}}
*To test the SQL string: copy and paste it to or from the text box displayed when activating the {{{Tools}}} + {{{SQL ...}}} menu item.
*The field or table names of the SQL argument may be surrounded by square brackets [], especially when they contain special characters like spaces. The brackets will be replaced by the appropriate quoting chaaracter(s), e.g. the double-quote for the HSQLDB database management system.
!!!Error messages
|Arguments are missing or are not initialized |
|SQL Error, SQL statement = '...' |
!!!See also
!!!Example
<<tiddler "Runsql example">>
Create a new database table
//{{{
If RunSQL( _
"CREATE TABLE customer (" _
& "First_Name char(50)" _
& ", Last_Name char(50)" _
& ", Address char(50)" _
& ", City char(50)" _
& ", Country char(25)" _
& ", Birth_Date date" _
& ")") Then MsgBox "Customer table has been created !"
//}}}
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<!-- Google Analytics Start -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30099972-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<!-- Google Analytics End -->
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>SITE_TITLE: TIDDLER_TITLE</title>
<meta name="description" content="SITE_SUBTITLE">
<meta name="keywords" content="OpenOffice, LibreOffice, MSAccess, Microsoft Access, API, VBA, Basic, It's about migrating people not data">
<script language="JavaScript" type="text/javascript">
location.href = 'TIDDLER_URL';
</script>
<base href="TIDDLER_URL">
</head>
<body>
<noscript>
<a href="TIDDLER_URL">TIDDLER_TITLE</a>
</noscript>
TIDDLER_CONTENT
</body>
</html>
/***
|''Name:''|SEOTiddlyWikiPlugin|
|''Version:''|last update: 2007-02-14|
|''Source''|http://www.superphysique.net#%5B%5BSEO%20TiddlyWiki%20Plugin%5D%5D ([[del.icio.us|http://del.icio.us/post?url=http://www.superphysique.net#%5B%5BSEO%20TiddlyWiki%20Plugin%5D%5D]])|
|''Author:''|Fabrice Proudhon|
|''Type:''|Plugin|
!Purpose
I wrote this Search Engine Optimization plugin to improve ~TiddlyWiki website's ranking on Google, Yahoo, etc. Basically, it does two things:
1) For each tiddler and each tag of this one, it creates a html file with the tiddler's content and named according to the tiddler's title. The html file is written in a way that it can be easily crawled by a search engine (short and with html format, not ~TiddlyWiki's format), but if it is opened (which will be the case if it appears in the results of a search engine), it redirects to the ~TiddlyWiki with the corresponding tiddler opened.
2) It creates the sitemap.xml and urllist.txt files for Google and Yahoo which included generated html files.
!How to install
1) Create two tiddlers like these one (same name and content):
[[SEOTiddlyWikiPlugin]] [[SEOTiddlyWikiConfig]]
NB: double-clic on each tiddler to get edit mode and copy-paste their content.
2) Fill in shadow tiddlers SiteUrl, SiteTitle and SiteSubtitle.
3) Edit this tiddler and see the code behind the following link to understand how to launch the process, once the plugin installed, add to a tiddler:
{{{<html><a href="javascript:generateSEOFiles();">Generate SEO files</a></html>}}}
which will generate a link as such: <html><a href="javascript:generateSEOFiles();">Generate SEO files</a></html>.
4) See http://www.google.com/webmasters/sitemaps/ to register your sitemap.xml file.
Tips
1) Feel free to modify html template [[SEOTiddlyWikiConfig]].
2) Use tag //excludeSearch// to disallow the export of a tiddler.
Limitation
If you remove a tiddler after an export, you have to manually remove the corresponding html file.
!Report a bug
<<email fabrice.proudhon at yahoo dot com>>
!Copyright
<html><!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by/2.5/"><img alt="Creative Commons License" style="border-width: 0" src="http://i.creativecommons.org/l/by/2.5/88x31.png"/></a><br/>This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/2.5/">Creative Commons Attribution 2.5 License</a>.<!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">
<Work rdf:about="">
<license rdf:resource="http://creativecommons.org/licenses/by/2.5/" />
</Work>
<License rdf:about="http://creativecommons.org/licenses/by/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/></License></rdf:RDF> --></html>
!Code
***/
//{{{
function generateSEOFiles()
{
// last update: 2007-02-14 by Fabrice Proudhon
// http://www.superphysique.net#%5B%5BSEO%20TiddlyWiki%20Plugin%5D%5D
var originalPath = document.location.toString();
if(originalPath.substr(0,5) != "file:")
{
alert(config.messages.notFileUrlError);
if(store.tiddlerExists(config.messages.saveInstructions))
story.displayTiddler(null,config.messages.saveInstructions);
return;
}
var y = [];
var g = [];
var localPath = getLocalPath(originalPath);
var c = store.getTiddlerText("SEOTiddlyWikiConfig");
var su = store.getTiddlerText("SiteUrl");
var st = wikifyPlain("SiteTitle");
var sbt = wikifyPlain("SiteSubtitle");
var htmlPath = localPath.substr(0,localPath.lastIndexOf("\\"));
var tiddlers = store.getTiddlers("modified","excludeLists");
g.push('<url><loc>' + su.htmlEncode() + '</loc></url>');
y.push(su.htmlEncode());
for (var t=0; t<tiddlers.length; t++) {
var content = c;
var filename = tiddlers[t].title.htmlEncode();
filename = filename.toLowerCase();
filename = filename.replace(/ |\/|@/gi, '-');
filename = filename.replace(/(-)\1+/gi, '$1');
content = content.replace(/SITE_TITLE/gi, st.htmlEncode());
content = content.replace(/SITE_SUBTITLE/gi, sbt.htmlEncode());
content = content.replace(/TIDDLER_TITLE/gi, tiddlers[t].title.htmlEncode());
content = content.replace(/TIDDLER_URL/gi, su.htmlEncode() + '#' + String.encodeTiddlyLink(tiddlers[t].title));
content = content.replace(/TIDDLER_KEYWORDS/gi, tiddlers[t].tags.join(',').htmlEncode());
content = content.replace(/TIDDLER_CONTENT/gi, wikifyStatic(tiddlers[t].text,null,tiddlers[t]).htmlEncode());
content = content.replace(/</gi, '<');
content = content.replace(/>/gi, '>');
content = content.replace(/"/gi, '"');
var d = tiddlers[t].modified.getFullYear() + '-';
if (tiddlers[t].modified.getMonth() + 1 < 10) d = d + '0';
d = d + (tiddlers[t].modified.getMonth() + 1) + '-';
if (tiddlers[t].modified.getDate() < 10) d = d + '0';
d = d + tiddlers[t].modified.getDate();
for (var ta=0; ta<tiddlers[t].tags.length; ta++) {
var tag = tiddlers[t].tags[ta].toLowerCase();
g.push('<url><loc>' + su.htmlEncode() + escape(tag) + '/' + escape(filename) + '.htm' + '</loc><lastmod>' + d + '</lastmod></url>');
y.push(su.htmlEncode() + escape(tag) + '/' + escape(filename) + '.htm');
saveFile(htmlPath + '\\' + tag + '\\' + filename + '.htm', convertUnicodeToUTF8(content));
}
}
saveFile(htmlPath + '\\urllist.txt', convertUnicodeToUTF8(y.join('\n')));
saveFile(htmlPath + '\\sitemap.xml', '<?xml version="1.0" encoding="utf-8"?><urlset xmlns="http://www.google.com/schemas/sitemap/0.84">\n' + convertUnicodeToUTF8(g.join('\n')) + '</urlset>');
displayMessage('SEO files created', '');
}
//}}}
(Q) Can I make a search box where the proposed choices are dynamically limited to those starting with the letters typed by the user ?
(R) There are several solutions. One of them is presented below.
The implemented module is triggered each time a character is entered.
Accepted characters are :
*Letters, either lower or upper cased, and the space character
*The BACKSPACE which cancels the last entered letter
*The ESCAPE key which cancels the complete string of characters.
Other keys are ignored.
The goal is to minimize the reload of the data from the database, as it is an operation that could take a long time while the user is keying letters in ...
!!!Solution
It consists in:
*A [[listbox|ListBox]]. It is reinitialized with database data at each //form loading//, and, while the focus is on the box, at each BACKSPACE key and at each ESCAPE key pressing.
*After each letter pressed by the user the box keeps only the subset of the initial data that corresponds with the entered characters, without database access. The control is temporarily converted from an SQL [[RowSourceType]] to a VALUELIST one.
*The succession of letters is kept into the [[Tag]] property of the //listbox//.
Let's assume next table:
<<tiddler "ProductsTable">>
The //listbox// will help to converge as quickly as possible to the searched product name.
1. Associate next code with the //When loading// form event:
//{{{
Sub InitList(Optional poEvent As Object) ' Optional because also called from CaptureChar routine
'Activated when form opened and when ESC key is pressed in listbox
Const cstForm = "Products_FastSearch"
Const cstList = "FastList"
Dim ocList As Object, sSource As String
Set ocList = Forms(cstForm).Controls(cstList)
If Not IsMissing(poEvent) Then ocList.Tag = "" ' Initialized only when form opened
ocList.RowSourceType = com.sun.star.form.ListSourceType.SQL
ocList.RowSource = "SELECT [ProductName] FROM [Products] ORDER BY [ProductName] ASC" 'Requery implicit
sSource = Join(ocList.ItemData, ";")
ocList.RowSourceType = com.sun.star.form.ListSourceType.VALUELIST ' For performance
ocList.RowSource = sSource
End Sub
//}}}
2. Associate next routine with the //Key pressed// event of the concerned //listbox// control :
//{{{
Sub CaptureChar(poEvent As Object)
Dim oEvent As Object, ocList As Object, sTag As String, i As Integer
Dim vList() As Variant, vNewList() As Variant, iNew As Integer
Set oEvent = Events(poEvent)
If oEvent.EventType <> "KEYEVENT" Then Exit Sub
'Accepted keys: A-Z, a-z, BACKSPACE, ESCAPE. All other keys ignored
'Tag property of list box is used to keep sequence of entered characters
With oEvent
Set ocList = oEvent.Source
Select Case True
Case .KeyAlt, .KeyCtrl : Exit Sub
Case .KeyCode = com.sun.star.awt.Key.ESCAPE
ocList.Tag = ""
Call InitList()
Exit Sub
Case .KeyCode = com.sun.star.awt.Key.BACKSPACE
If Len(ocList.Tag) > 0 Then
sTag = ocList.Tag
ocList.Tag = Left(sTag, Len(sTag) - 1) ' Reduce length of Tag
Call InitList()
End If
Case (UCase(.KeyChar) >= "A" And UCase(.KeyChar) <= "Z") Or (.KeyCode = com.sun.star.awt.Key.SPACE)
ocList.Tag = ocList.Tag & .KeyChar
Case Else : Exit Sub
End Select
End With
With ocList ' Process Tag
sTag = .Tag
vList() = Split(.RowSource, ";")
.RowSource = ""
vNewList() = Array() ' Otherwise Redim protests
If UBound(vList) >= 0 Then
ReDim vNewList(0 To UBound(vList)) ' Resized later
iNew = 0 ' Counts valid entries in vList
For i = 0 To UBound(vList)
If Len(vList(i)) >= Len(sTag) Then
If UCase(Left(vList(i), Len(sTag))) = UCase(sTag) Then ' Case not sensitive
vNewList(iNew) = vList(i)
iNew = iNew + 1
End If
End If
Next i
If iNew > 0 Then
ReDim Preserve vNewList(0 To iNew - 1)
.RowSource = Join(vNewlist, ";") 'Apply new list after Tag selection
.ListIndex = 0 'Select first element
End If
End If
End With
End Sub
//}}}
!!!See also
[[Event]]
[[ItemData]]
[[ListIndex]]
[[RowSource]]
[[RowSourceType]]
[[Tag]]
The //~SelectObject// [[action|Actions]] moves the focus to the specified window.
!!!Syntax
{{{SelectObject(}}}//{{{ObjectType, ObjectName, InDatabaseWindow}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description | !Returned Value |
|{{{ObjectType}}} | No | acTable<br />acQuery<br />acForm<br />acReport<br />acDiagram (i.e. Relationships)<br />acBasicIDE<br />acDatabaseWindow |The type of object to set the focus on. | True if sucess |
|{{{ObjectName}}} | Yes | String |The name of the object to set the focus on. This argument is NOT case-sensitive.<br />The argument is mandatory when the //~ObjectType// argument is one of next values: //acTable//, //acQuery//, //acForm// or //acReport//. |~|
|{{{InDatabaseWindow}}} | Yes | Boolean |Specifies if the object has to be selected in the Database Window.<br />Must be FALSE. |~|
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acDiagram = 8
Global Const acForm = 2
Global Const acQuery = 1
Global Const acReport = 3
Global Const acTable = 0
Global Const acBasicIDE = 101
Global Const acDatabaseWindow = 102
//}}}
!!!Remarks
The selected window MUST NOT be minimized or hidden. Otherwise the ~SelectObject action will ignore the request.
!!!Error messages
|Arguments are missing or are not initialized |
|Argument nr. 1 is invalid |
|Object '...' not found |
!!!See also
[[Maximize]]
[[Minimize]]
[[MoveSize]]
[[RunCommand]]
[[setFocus]]
!!!Example
<<tiddler "SelectObject example">>
Select the database window and minimize it, then set focus on an open form.
//{{{
Const acForm = 2
Const acDatabaseWindow = 102
SelectObject(acDatabaseWindow)
Minimize()
SelectObject(acForm, "myForm")
Maximize()
//}}}
The //Selected// property determines if the specified row in a combo box or list box is currently selected.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | [[ListBox]] | [[ListBox]] |A listbox on an open form or in a [[GridControl]]|
!!!Syntax
//control//{{{.Selected}}}
//control//{{{.Selected(}}}//index//{{{)}}}
//control//{{{.Selected}}} = //value//
{{{setSelected(}}}//control, value, index//{{{)}}}
!!!Returned values / Arguments
{{{Array of Booleans}}} (might be empty) if index is absent.
{{{Boolean}}} if index is present
!!!Remarks
It is better to use the [[Value]] property for non-multiselect listboxes.
The //index// argument must have a (integer or long) value between 0 and (//~ListCount// - 1)
If //index// is absent//control//{{{.Selected}}} returns an array [0 ... //~ListCount// - 1]. If the listbox is empty the returned array is also empty.
If //index// is absent the //value// argument must be an array [0 ... //~ListCount// - 1].
The use of {{{setSelected(}}}//control, value, index//{{{)}}} as syntax is due to the incapacity of Basic to accept Optional arguments in Property Let routines.
!!!Error messages
|Argument nr.X is invalid |
|Property 'Selected' not applicable in this context |
|Out of array range or incorrect array size for property 'Selected'|
!!!See also
[[ItemData]]
[[ListCount]]
[[ListIndex]]
[[MultiSelect]]
[[RowSource]]
[[RowSourceType]]
[[Value]]
!!!Example
*List box
<<tiddler "ListBox example">>
{{firstletter{
@@color:#930;T@@
}}}he //~SendObject// [[action|Actions]] outputs the data in the specified object (currently only a form) to several output formats and inserts it into an e-mail. Recipients, subject and other elements can be inserted automatically as well.
!!!Syntax
{{{SendObject(}}}//{{{ObjectType, ObjectName, OutputFormat, To, Cc, Bcc, Subject, MessageText, EditMessage, TemplateFile}}}//{{{)}}}
| !Argument | !Optional | !Type<br />or<br />Symbol |!Description | !Returned value |
|{{{ObjectType}}} | Yes | acSendNoObject<br />acSendForm |The type of object to output.<br />If absent the default value is {{{acSendNoObject}}}. | {{{True}}} if success |
|{{{ObjectName}}} | Yes | String |The valid name of an object of the type selected by the //~ObjectType// argument. If you want to output the active object, specify the object's type for the {{{ObjectType}}} argument and leave this argument blank.<br />If the {{{ObjectType}}} argument is left empty or is equal to the default value, if this argument if not empty, then it will be interpreted as the full path name of the file to attach to the mail. |~|
|{{{OutputFormat}}} | Yes | acFormatPDF<br />acFormatODT<br />acFormatDOC<br />acFormatHTML |The output format, expressed as an acFormatXXX constant. If this argument is omitted, te user will be prompted for the output format. |~|
|{{{To}}} | Yes | String |The recipients of the message whose names you want to put on the To line in the mail message.<br />Separate the recipients' names you specify in this argument (and in the Cc and Bcc arguments) with a semicolon (;).<br />If the mail application can't identify the recipients' names, the message isn't sent and an error occurs. |~|
|{{{Cc}}} | Yes | String |The message recipients whose names you want to put on the Cc ("carbon copy") line in the mail message. |~|
|{{{Bcc}}} | Yes | String |The message recipients whose names you want to put on the Bcc ("blind carbon copy") line in the mail message. |~|
|{{{Subject}}} | Yes | String |The subject of the message. This text appears on the Subject line in the mail message. |~|
|{{{MessageText}}} | Yes | String |Any text you want to include in the message in addition to the database object. This text appears in the main body of the mail message. If you leave this argument blank, no additional text is included in the mail message.<br />If you leave the {{{ObjectType}}} and {{{ObjectName}}} arguments blank, you can use this argument to send a mail message without a database object. |~|
|{{{EditMessage}}} | Yes | Boolean |Specifies whether the message can be edited before it's sent. If you select {{{True}}}, the electronic mail application starts automatically, and the message can be edited. If you select {{{False}}}, the message is sent without the user having a chance to edit the message.<br />The default is {{{True}}}. |~|
|{{{TemplateFile}}} | Yes | String |If present, must be a null-length string. |~|
The symbolic constants can be included in your code by copying and pasting next lines:
//{{{
Global Const acSendForm = 2
Global Const acSendNoObject = -1
Global Const acFormatPDF = "writer_pdf_Export"
Global Const acFormatODT = "writer8"
Global Const acFormatDOC = "MS Word 97"
Global Const acFormatHTML = "HTML"
//}}}
!!!Remarks
*//~Access2Base// uses for the sending of the mail the most appropriate of next protocols:
| !Protocol | !Used when | !Limitations | !Consequence |
| mailto: |{{{ObjectType}}} left empty or = {{{acSendNoObject}}} and {{{ObjectName}}} left blank. |No attachments<br />Message edition always allowed. |The {{{EditMessage}}} argument is ignored. |
| ~XSimpleMailMessage<br />UNO interface |All other cases. |No Body insertion |The {{{MessageText}}} argument is ignored. |
|~|~|Maximum 1 "To" recipient |All the "To" recipients as from the 2nd in the list are added to the "Cc" recipients list. |
*If a form has to be sent, the designated form MUST be open before the //~SendObject// action is called.
*If the {{{ObjectName}}} argument is a file name then it may be expressed either in the (recommended) URL format (i.e. "{{{file:// ...}}}") or by using the operating system usual syntax (e.g. "{{{C:\...}}}" in Windows).
*When the form is transformed into another format, //~Access2Base// will use as temporary directory the directory mentioned in the //AOO/~LibO// {{{Options}}} for the {{{Paths/Temporary files}}} parameter.
!!!Error messages
|Object '...' not found |
|Action not applicable in this context |
|Mail service could not be activated |
!!!See also
[[OutputTo]]
[[SelectObject]]
!!!Example
<<tiddler "SendObject example">>
To send a message without attachments, with a body. The mail client will open before the message being sent.
//{{{
SendObject( , , , "abc@def.com;ghi@def.com","xyz@abc.eu",,"This is the subject", "This is" & chr(13) & "the body")
//}}}
To send a file as attachment. The body will however be ignored. The mail client will open before the message being sent.
//{{{
Const acFormatPDF = "writer_pdf_Export"
SendObject(, "file:///C:/Users/MyName/Documents/Doc/Access2Base/access2base.html" _
, acFormatPDF, "abc@def.com;me@sdf.eu", "aaa@kk.it;bbb@kk.it", "me@mail.be", "This is the subject", "This is" & chr(13) & "a useless body" _
)
//}}}
To send a form in PDF as attachment in the mail, the mail client will not propose to edit the message
//{{{
Const acFormatPDF = "writer_pdf_Export"
SendObject(acSendForm, "myForm", acFormatPDF, "toyou@yourmail.eu", , , "Read carefully the attached file", , False)
//}}}
The shortcut n{{firstletter{
@@color:#930;T@@
}}}ation allows to reach an [[object|Object Model]] or anyone of its properties by mean of a call to one single function. The first argument of the function is a string designating unambiguously the target [[form|Form]], or [[control|Control]], or one of their properties.
!!!The shortcut notation
The //shortcut notation// binds several //components// by mean of two operators:
*The "!" (exclamation mark)<br />The component on the left of the "!" is a //parent// of the component on its right. A //parent// may be a [[collection|Collection]] or an [[object|Object Model]] containing other //objects//, just like __a form__ may __contain controls__.<br />The first component must be a collection, the only allowed collection being [[Forms]].
*The "." (dot)<br />The dot separates an object on its left from one of the properties of the object on its right.
Note that the //shortcut notation// is NOT case-sensitive.
!!!Examples
*The //myForm// form:
//{{{
Forms!myForm
//}}}
*The AllowEdits property of //myForm//:
//{{{
Forms!myForm.AllowEdits
//}}}
*A control in //myForm//:
//{{{
Forms!myForm!myControl
//}}}
*The BackColor property of //myControl//:
//{{{
Forms!myForm!myControl.BackColor
//}}}
*A control in a subform:
//{{{
Forms!myForm!mySubForm.Form!mySubcontrol
//}}}
*The [[ControlTipText]] property of a control in a [[gridcontrol|GridControl]] located itself in a subform:
//{{{
Forms!myForm!mySubForm.Form!myGridControl!mySubControl.ControlTipText
//}}}
!!!Associated functions
| !Function | !Description |
|[[getObject]] |Returns an object corresponding with its argument. |
|[[getValue]] |Returns a property of the object corresponding with its argument. |
|[[setValue]] |Sets a property of the object corresponding with its first argument. |
(Q) Can I reach any control on any form with the shortcut notation ?
(R) The [[ShortCut Notation]] is a very rapid mean to reach the control or form you want and ...
*get with the [[getObject]] function its corresponding //~Access2Base// [[form|Form]] or [[control|Control]] [[object|Object Model]]
*get or set - with [[getValue]] or [[setValue]] - any property of the targetted object
The //shortcut notation// binds several //components// by mean of two operators:
*The "!" (exclamation mark)<br />The component on the left of the "!" is a //parent// of the component on its right. A //parent// may be a [[collection|Collection]] or an [[object|Object Model]] containing other //objects//, just like __a form__ may __contain controls__.<br />The first component must be a collection, the only allowed collection being [[Forms]].
*The "." (dot)<br />The dot separates an object on its left from one of the properties of the object on its right.
Note also that a shortcut is NOT case-sensitive.
Let's assume
#//Mainform// is the name of the top level FORM
#//Subform1// is the name of the subform CONTROL on //Mainform//
#//Subform2// is the name of the subform CONTROL on //Subform1//
#//~Subform2_Grid// is the name of the grid CONTROL contained in //Subform2//
!!!To refer to a form property, like [[RecordSource]]
|On //Mainform// |Forms!Mainform.~RecordSource |
|On //Subform1// |Forms!Mainform!Subform1.Form.~RecordSource |
|On //Subform2// |Forms!Mainform!Subform1.Form!Subform2.Form.~RecordSource |
!!!To refer to a control
|On //Mainform// |Forms!Mainform!~ControlName |
|On //Subform1// |Forms!Mainform!Subform1.Form!~ControlName |
|On //Subform2// |Forms!Mainform!Subform1.Form!Subform2.Form!~ControlName |
|On //~Subform2_Grid// |Forms!Mainform!Subform1.Form!Subform2.Form!~Subform2_Grid!~ControlName |
!!!To refer to a control property, like [[Enabled]]
|On //Mainform// |Forms!Mainform!~ControlName.Enabled |
|On //Subform1// |Forms!Mainform!Subform1.Form!~ControlName.Enabled |
|On //Subform2// |Forms!Mainform!Subform1.Form!Subform2.Form!~ControlName.Enabled |
|On //~Subform2_Grid// |Forms!Mainform!Subform1.Form!Subform2.Form!~Subform2_Grid!~ControlName.Enabled |
!!!To refer to a subform or grid control property, like [[Name]]
|On //Subform1// |Forms!Mainform!Subform1.Name |
|On //Subform2// |Forms!Mainform!Subform1.Form!Subform2.Name |
|On //~Subform2_Grid// |Forms!Mainform!Subform1.Form!Subform2.Form!~Subform2_Grid.Name |
{{firstletter{
@@color:#930;T@@
}}}he //ShowAllRecords// [[action|Actions]] removes any existing filters and sorts that may exist on the current table, query, or form.
!!!Syntax
{{{ShowAllRecords()}}}
!!!Remarks
*The //~ShowAllrecords// action is usually preceded by a [[SelectObject]] action or by the [[setFocus]] method applied on the targeted //form//.
*//~ShowAllRecords// returns {{{True}}} if the action was successful, {{{False}}} otherwise.
!!!Error messages
!!!See also
[[SelectObject]]
[[setFocus]]
!!!Example
<<tiddler "ShowAllRecords example">>
Reset existing filter or sort on an open form
//{{{
SelectObject(acForm, "myForm")
ShowAllRecords
//}}}
{{indent{It's about migrating ''PEOPLE'', not data
http://www.access2base.com/access2base.html
/***
|''Name:''|SpecificA2BPlugin|
|''Description:''|Forces readOnly to true or false. Useful to distribute a ReadOnly version of Access2Base help file. Set value to //true// in code below.|
!Code
***/
//{{{
readOnly = (window.location.protocol == "file:") ? true : config.options.chkHttpReadOnly;
//}}}
/***
|''Description:''|Modify tiddler tooltip for anonymisation.<br>Standard value: "%0 - %1, %2".|
!Code
***/
//{{{
merge(config.messages,{
tiddlerLinkTooltip: "%0 - Click to open",
});
//}}}
/***
|''Description''|Modify the header of the List macro.|
!Code
***/
//{{{
config.macros.list.all.prompt = "All topics in alphabetical order";
//}}}
Connect a standalone form to the target database:
//{{{
Sub DBOpen(Optional poEvent As Object)
If GlobalScope.BasicLibraries.hasByName("Access2Base") then _
GlobalScope.BasicLibraries.LoadLibrary("Access2Base")
Call OpenConnection(ThisComponent)
End Sub
//}}}
{{firstletter{
@@color:#930;S@@
}}}//tandalone forms// are pure AOO/~LibO Writer documents, usually built from a normal //form// Base object - but not necessarily - containing a form (at least one), controls, etc. These form and controls may be linked with data located in databases thru the use of a Base document (".odb" file).
To make such forms, documentation is available on several forums, e.g. [[here|http://user.services.openoffice.org/en/forum/viewtopic.php?t=40493]].
//~Access2Base// may be invoked from macros located in a //standalone form//. However NOT ALL the properties, methods, actions etc. are meaningful in such a context.
Find below the status by function. If not mentioned a function is available without restriction.
In addition a //standalone form// does see the //Table// and //Query// objects stored within the database document (".odb" file) where it is connected with.
At the opposite:
|''A //standalone form// CANNOT INTERACT with the other (either standalone or embedded) forms.''|
Several standalone forms might be opened at the same time, all using the //~Access2Base// API.
!!Use the extension
To be able to invoke the //~Access2Base// API from a AOO/~LibO ".odt" file (the usual suffix for text //Writer// documents) you have to
*Have a minimal knowledge of the Basic IDE.
*Open the ".odt" file (the standalone form) and edit at least next macro:
<<tiddler "Standalone Connect example">>
*Assign with menu items {{{Tools + Customize...}}} ({{{Events}}} tab) the above Sub ("~DBOpen" in the example but use the name of your choice) to the //~OpenDocument// event. Save in the ".odt" file itself.
*//Close// and re-//open// the ".odt" file. This will trigger the //~OpenDocument// event.
*Start programming macro's. Associate them with //form// or //control events// if relevant
!!Next functions are available __with limitations__
| !Function | !Limitation |
|[[AllForms]] |The //~AllForms// collection is limited to the //standalone form// itself.<br />The smart syntax for invoking //~AllForms// is simply:<br />{{{AllForms(0)}}}<br />which will return a //form object// representing the //standalone form// itself giving as such access to its individual controls. |
|[[SelectObject]] |The objects opened from a Base document (".odb") - tables, queries, etc. - can be selected from a //standalone form//.<br />Similarly //Standalone forms// can be selected from a Base document (".odb").<br />However no interaction is possible between them thru the //~Access2Base// API. |
|[[OpenArgs]] |The //~OpenArg// (read-only) property always returns a zero-length string. |
!!Next functions are not available
//~Access2Base// will generate an error if one of next functions is invoked from a //standalone form// context.
| !Function |
|[[Close]] |
|[[OpenForm]], [[OpenQuery]], [[OpenReport]], [[OpenTable]] |
!!See also ...
[[OpenConnection]].
/***
!~TiddlyWiki Classic Color Scheme
Designed by Jeremy Ruston
http://tiddlystyles.com/#theme:Classic
To use this color scheme copy the ~ClassicTiddlyWiki contents into a tiddler and name it 'StyleSheet' also grab the ~ClassicTemplate and copy its contents into a tiddler named 'PageTemplate'.
!Colors Used
*@@bgcolor(#630):color(#fff): #630@@
*@@bgcolor(#930): #930@@
*@@bgcolor(#996633): #963@@
*@@bgcolor(#c90): #c90@@
*@@bgcolor(#cf6): #cf6@@
*@@bgcolor(#cc9): #cc9@@
*@@bgcolor(#ba9): #ba9@@
*@@bgcolor(#996): #996@@
*@@bgcolor(#300):color(#fff): #300@@
*@@bgcolor(#000000):color(#fff): #000@@
*@@bgcolor(#666): #666@@
*@@bgcolor(#888): #888@@
*@@bgcolor(#aaa): #aaa@@
*@@bgcolor(#ddd): #ddd@@
*@@bgcolor(#eee): #eee@@
*@@bgcolor(#ffffff): #fff@@
*@@bgcolor(#f00): #f00@@
*@@bgcolor(#ff3): #ff3@@
!Generic Rules /%==============================================%/
***/
/*{{{*/
body {
background: #fff;
color: #000;
}
a{
color: #963;
}
a:hover{
background: #963;
color: #fff;
}
a img{
border: 0;
}
h1,h2,h3,h4,h5 {
background: #cc9;
}
/*}}}*/
/***
!Header /%==================================================%/
***/
/*{{{*/
.header{
background: #300;
}
.titleLine {
color: #fff;
padding: 5em 0em 1em .5em;
}
.titleLine a {
color: #cf6;
}
.titleLine a:hover {
background: transparent;
}
/*}}}*/
/***
!Main Menu /%=================================================%/
***/
/*{{{*/
#mainMenu .button {
color: #930;
}
#mainMenu .button:hover {
color: #cf6;
background: #930;
}
#mainMenu li{
list-style: none;
}
/*}}}*/
/***
!Sidebar options /%=================================================%/
~TiddlyLinks and buttons are treated identically in the sidebar and slider panel
***/
/*{{{*/
#sidebar {
background: #c90;
right: 0;
}
#sidebarOptions a{
color: #930;
border: 0;
margin: 0;
padding: .25em .5em;
}
#sidebarOptions a:hover {
color: #cf6;
background: #930;
}
#sidebarOptions a:active {
color: #930;
background: #cf6;
}
#sidebarOptions .sliderPanel {
background: #eea;
margin: 0;
}
#sidebarOptions .sliderPanel a {
color: #930;
}
#sidebarOptions .sliderPanel a:hover {
color: #cf6;
background: #930;
}
#sidebarOptions .sliderPanel a:active {
color: #930;
background: #cf6;
}
/*}}}*/
/***
!Sidebar tabs /%=================================================%/
***/
/*{{{*/
.tabSelected,.tabContents {
background: #eea;
border: 0;
}
.tabUnselected {
background: #c90;
}
#sidebarTabs {
background: #c90;
}
#sidebarTabs .tabSelected{
color: #cf6;
background: #963;
}
#sidebarTabs .tabUnselected {
color: #cf6;
background: #930;
}
#sidebarTabs .tabContents{
background: #963;
}
#sidebarTabs .txtMoreTab .tabSelected,
#sidebarTabs .txtMoreTab .tabSelected:hover{
background: #930;
color: #cf6;
}
#sidebarTabs .txtMoreTab .tabUnselected,
#sidebarTabs .txtMoreTab .tabUnselected:hover{
background: #300;
color: #cf6;
}
#sidebarTabs .txtMoreTab .tabContents {
background: #930;
}
#sidebarTabs .tabContents a {
color: #cf6;
border: 0;
}
#sidebarTabs .button.highlight,
#sidebarTabs .tabContents a:hover {
background: #cf6;
color: #300;
}
/*}}}*/
/***
!Message Area /%=================================================%/
***/
/*{{{*/
#messageArea {
background: #930;
color: #fff;
}
#messageArea a:link, #messageArea a:visited {
color: #c90;
}
#messageArea a:hover {
color: #963;
background: transparent;
}
#messageArea a:active {
color: #fff;
}
/*}}}*/
/***
!Popup /%=================================================%/
***/
/*{{{*/
.popup {
background: #eea;
border: 1px solid #930;
}
.popup hr {
color: #963;
background: #963;
border-bottom: 1px;
}
.popup li.disabled {
color: #ba9;
}
.popup li a, .popup li a:visited {
color: #300;
}
.popup li a:hover {
background: #930;
color: #eea;
}
/*}}}*/
/***
!Tiddler Display /%=================================================%/
***/
/*{{{*/
.tiddler .button {
color: #930;
}
.tiddler .button:hover {
color: #cf6;
background: #930;
}
.tiddler .button:active {
color: #fff;
background: #c90;
}
.shadow .title {
color: #888;
}
.title {
color: #422;
}
.subtitle {
color: #866;
}
.toolbar {
color: #aaa;
}
.toolbar a,
.toolbar a:hover{
border: 0;
}
.tagging, .tagged {
border: 1px solid #fff;
background-color: #ffc;
}
.selected .tagging, .selected .tagged {
border: 1px solid #aa6;
background-color: #ffc;
}
.tagging .listTitle, .tagged .listTitle {
color: #999999;
}
.footer {
color: #ddd;
}
.selected .footer {
color: #888;
}
.sparkline {
background: #eea;
border: 0;
}
.sparktick {
background: #930;
}
.errorButton {
color: #ff0;
background: #f00;
}
.zoomer {
color: #963;
border: 1px solid #963;
}
/*}}}*/
/***
''The viewer is where the tiddler content is displayed'' /%------------------------------------------------%/
***/
/*{{{*/
.viewer .button {
background: #c90;
color: #300;
border-right: 1px solid #300;
border-bottom: 1px solid #300;
}
.viewer .button:hover {
background: #eea;
color: #c90;
}
.viewer .imageLink{
background: transparent;
}
.viewer blockquote {
border-left: 3px solid #666;
}
.viewer table {
border: 2px solid #303030;
}
.viewer th, thead td {
background: #996;
border: 1px solid #606060;
color: #fff;
}
.viewer td, .viewer tr {
border: 1px solid #606060;
}
.viewer pre {
border: 1px solid #963;
background: #eea;
}
.viewer code {
color: #630;
}
.viewer hr {
border: 0;
border-top: dashed 1px #606060;
color: #666;
}
.highlight, .marked {
background: #ff3;
}
/*}}}*/
/***
''The editor replaces the viewer in the tiddler'' /%------------------------------------------------%/
***/
/*{{{*/
.editor input {
border: 1px solid #000;
}
.editor textarea {
border: 1px solid #000;
width: 100%;
}
.editorFooter {
color: #aaa;
}
.editorFooter a {
color: #930;
}
.editorFooter a:hover {
color: #cf6;
background: #930;
}
.editorFooter a:active {
color: #fff;
background: #c90;
}
/*}}}*/
/***
!Specific addition for ~Access2Base /%=================================================%/
***/
/*{{{*/
@media print {#mainMenu {display: none ! important;}}
@media print {#topMenu {display: none ! important;}}
@media print {#sidebar {display: none ! important;}}
@media print {#messageArea {display: none ! important;}}
@media print {#toolbar {display: none ! important;}}
@media print {.header {display: none ! important;}}
@media print {.tiddler .subtitle {display: none ! important;}}
@media print {.tiddler .toolbar {display; none ! important; }}
@media print {.tiddler .tagging {display; none ! important; }}
@media print {.tiddler .tagged {display; none ! important; }}
#mainMenu {
position:absolute;
left:0;
width:13em;
text-align:right;
line-height:1.6em;
padding:1.5em 0.5em 0.5em 0.5em;
font-size:1.1em;
}
#displayArea {
margin:1em 17em 0 16em;
}
.titleLine {
color: #fff;
padding: 3em 0em 1em .5em;
}
.firstletter{ float:left; width:0.75em; font-size:400%; font-family:times,arial; line-height:60%; }
.tiddler .subtitle { display:none; }
/*}}}*/
/*~StyleSheetShortcuts*/
{{firstletter{
@@color:#930;A@@
}}} //~SubForm// [[object|Object Model]] represents a subset of the controls of an open //form//. The open form is called the "parent form" or "master". ~SubForms are used mainly to access more than one table (or query) from a //form//. Each additional table requires its own //subform//.
!!!Properties returning a subform object
| !Property | !Object |!Description |
|[[Form|Form (subform)]] | [[Control]] |A //subform// is a //Control// like another. The //Form// property of a control of type //~SubForm// will return a //~SubForm// [[object|Object Model]]. |
!!!Properties
| !Property | !Type | !Read only | !Description or UNO object |
|[[Name]] || Y |Specifies the exact name of the subform control. |
|[[AllowAdditions]] |||Specifies whether a user can add a record when using the subform. |
|[[AllowDeletions]] |||Specifies whether a user can delete a record when using the subform. |
|[[AllowEdits]] |||Specifies whether a user can modify a record when using the subform. |
|[[Filter]] |||Specifies a subset of records to be displayed. |
|[[FilterOn]] |||Specifies if the Filter has to be applied. |
|[[LinkChildFields]]<br />[[LinkMasterFields]] || Y |Specifies how records in the subform (//child//) are linked to records in its parent (//master//) form. |
|[[ObjectType]] || Y |Returns "SUBFORM" |
|[[Parent]] || Y |Returns the parent object of the subform. |
|[[RecordSource]] |||Specifies the source of the data. |
|~ParentComponent | UNO | Y |com.sun.star.text.~TextDocument |
|~DatabaseForm | UNO | Y |com.sun.star.form.component.~DataForm<br />com.sun.star.sdb.~ResultSet |
!!!Methods
| !Method | !Argument(s) | !Return | !Description |
|[[hasProperty]] | property | Boolean |Return True if the ~SubForm has the given property. |
|[[Requery]] || Boolean |True if data reloaded in ~SubForm |
!!!Remarks
Each //~SubForm// [[object|Object Model]] has a Controls [[collection|Collection]], which contains all controls on the subform. You can refer to a specific control on a subform by referring to the [[Controls]] collection.
!!!Example
<<tiddler "Subform example">>
The types of control can be recognized thru the use either of the //~SubType// or the [[ControlType]] properties. The ~SubType property has no correspondent within ~MSAccess but has the advantage to identify all control types.
See the correspondence table below.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | All | All |A control on an open form |
!!!Syntax
//control//{{{.SubType}}}
!!!Returned values
{{{String}}}
Table of values:
<<tiddler "ControlTypesList">>
!!!Remarks
The ~SubType property is read-only.
!!!Error messages
!!!See also
[[ControlType]]
!!!Example
<<tiddler "ControlType example">>
List all the controls of a subform
//{{{
Dim ocSubform As Object, osfSubform As Object, i As Integer, iCount As Integer
Set ocSubform = Controls("FACTURE", "subform")
Set osfSubform = ocSubform.Form
iCount = osfSubform.Controls().Count
For i = 0 To iCount - 1
Print osfSubform.Controls(i).Name,
Next i
Print
//}}}
*Suppliers table
| !Fields | !Field Type | !Primary |
|Address | Text ||
|City | Text ||
|~ComanyName | Text ||
|~ContactName | Text ||
|~ContactTitle | Text ||
|Country | Text ||
|Fax | Text ||
|~HomePage | Text ||
|Phone | Text ||
|~PostalCode | Text ||
|Region | Text ||
|~SupplierID | ~BigInt | Y |
(Q) How can I limit the contents of one combo/list box based on what's selected in another combo/list box ?
(R) An easy way to do this would be to assign a dynamic SQL statement to the [[RowSource]] property of the secondary combo/list box at runtime.
Our goal in the example is to select in a 1st combo box a CITY, in the 2nd combo the LASTNAME of the employees (working in CITY) to filter finally only the //Orders// placed by the concerned //Employee//.
Considering
<<tiddler "EmployeesTable">>
*Initialize the //List content// entry of the 1st combo box with:
//{{{
SELECT DISTINCT "City" FROM "Employees"
//}}}
*Assign next Sub to the //Text modified// event of the 1st combo box:
//{{{
Sub Update2ndCombo(poEvent As Object)
Dim ocCombo1 As Object, ocCombo2 As Object, sSQL As String
Set ocCombo1 = Events(poEvent).Source
Set ocCombo2 = ocCombo1.Parent.Controls("EmployeeName")
sSQL = "SELECT DISTINCT [LastName] FROM [Employees] WHERE [Employees].[City]='" & ocCombo1.Value & "'"
ocCombo2.RowSourceType = com.sun.star.form.ListSourceType.SQL
ocCombo2.RowSource = sSQL
End Sub
//}}}
*Initilialize the //List content// entry of the 2nd combo box with:
//{{{
SELECT DISTINCT "LastName" FROM "Employees"
//}}}
*Assign next Sub to the //Text modified// event of the 2nd combo box:
//{{{
Sub UpdateMainForm(poEvent As Object)
Dim ofForm As Object, ocCombo As Object, sSQL As String, lEmpID As Integer
Set ocCombo = Events(poEvent).Source
Set ofForm = ocCombo.Parent
lEmpID = DLookup("[EmployeeID]", "[Employees]", "[LastName]='" & ocCombo.Value & "'")
ofForm.Filter = "[EmployeeID]=" & lEmpID
ofForm.FilterOn = True
End Sub
//}}}
The //~TabIndex// property specifies a control's place in the tab order on a form.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~FixedText<br />~GroupBox<br />~HiddenControl<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.TabIndex}}}
//control//{{{.TabIndex}}} = //value//
!!!Returned values / Arguments
{{{Integer}}} or {{{Long}}}
!!!Remarks
The default -1 is used to indicate that the tab-order of this control should be determined automatically.
!!!Error messages
|Property '~TabIndex' not applicable in this context |
|Value '...' is invalid for property '~TabIndex' |
!!!See also
[[TabStop]]
!!!Example
<<tiddler "TabIndex example">>
List all controls in ~TabIndex ascending sequence. Only initialized ~TabIndexes are included.
//{{{
Dim ofForm As Object, ocControl As Object, i As Integer, iCount As Integer
Dim sNames() As String
Set ofForm = Forms("myForm")
iCount = ofForm.Controls().Count
ReDim sNames(0 To iCount - 1)
For i = 0 To iCount - 1
Set ocControl = ofForm.Controls(i)
If ocControl.hasProperty("TABINDEX") Then
If ocControl.TabIndex > 0 And ocControl.TabIndex < iCount Then sNames(ocControl.TabIndex) = ocControl.Name
End If
Next i
For i = 0 To iCount - 1
If sNames(i) <> "" Then Print sNames(i),
Next i
Print
//}}}
Reset Tab sequence to automatic
//{{{
For i = 0 To iCount - 1
If sNames(i) <> "" Then
Set ocControl = ofForm.Controls(sNames(i))
ocControl.TabIndex = -1
End If
Next i
//}}}
The //~TabStop// property specifies if the focus can be set on a control by using .the TAB key.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~FixedText<br />~GroupBox<br />~HiddenControl<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//control//{{{.TabStop}}}
//control//{{{.TabStop}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
!!!Error messages
|Property '~TabStop' not applicable in this context |
|Value '...' is invalid for property '~TabStop' |
!!!See also
[[TabIndex]]
!!!Example
<<tiddler "TabStop example">>
List all controls having ~TabStop = True
//{{{
Dim ofForm As Object, ocControl As Object, i As Integer
Set ofForm = Forms("myForm")
For i = 0 To ofForm.Controls().Count - 1
Set ocControl = ofForm.Controls(i)
If ocControl.hasProperty("TABSTOP") Then
If ocControl.TabStop Then Print ocControl.Name,
End If
Next i
Print
//}}}
Forbid access to myControl via Tab key
//{{{
Set ocControl = ofForm.Controls("myControl")
ocControl.TabStop = False
//}}}
The //Tag// property stores extra information about a [[Control]].
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |All except<br />--~SubForm<br />-- | All |A control on an open form |
!!!Syntax
//control//{{{.Tag}}}
//control//{{{.Tag}}} = //value//
!!!Returned values / Arguments
{{{String}}}
!!!Remarks
You can use this property to assign an identification string to a control without affecting any of its other property settings or causing other side effects. The //Tag// property is useful when you need to check the identity of a control that is passed as a variable to a procedure.
!!!Error messages
|Value '...' is invalid for property 'Tag' |
!!!See also
[[OpenArgs]]
!!!Example
<<tiddler "Tag example">>
Associate a tag value to a control
//{{{
Dim ofForm As Object, ocControl As Object, sTag As String
sTag = "This is an informative message"
Set ofForm = Forms("myForm")
Set ocControl = ofForm.Controls("myControl")
ocControl.Tag = sTag
//}}}
Usage: f.i. displaying the tag content in a info textbox when the control receives the focus
/***
|''Name:''|TagsTreePlugin|
|''Description:''|Displays tags hierachy as a tree of tagged tiddlers.<br>Can be used to create dynamic outline navigation.|
|''Version:''|1.0.1|
|''Date:''|Jan 04,2008|
|''Source:''|http://visualtw.ouvaton.org/VisualTW.html|
|''Author:''|Pascal Collin|
|''License:''|[[BSD open source license|License]]|
|''~CoreVersion:''|2.1.0|
|''Browser:''|Firefox 2.0; InternetExplorer 6.0|
!Demo
On the plugin [[homepage|http://visualtw.ouvaton.org/VisualTW.html]] :
*Try to tag some <<newTiddler>> with a tag displayed in the menu and edit MainMenu.
*Look at some tags like [[Plugins]] or [[menu]].
!Installation
#import the plugin,
#save and reload,
#optionally, edit TagsTreeStyleSheet.
! Usage
{{{<<tagsTree>>}}} macro accepts the following //optional// parameters.
|!#|!parameter|!description|!by default|
|1|{{{root}}}|Uses {{{root}}} tag as tree root|- In a //tiddler// content or template : uses the tiddler as root tag.<br>- In the //page// content or template (by ex MainMenu) : displays all untagged tags.|
|2|{{{excludeTag}}}|Excludes all such tagged tiddlers from the tree|Uses default excludeLists tag|
|3|{{{level}}}|Expands nodes until level {{{level}}}.<br>Value {{{0}}} hides expand/collapse buttons.|Nodes are collapsed on first level|
|4|{{{depth}}}|Hierachy depth|6 levels depth (H1 to H6 header styles)|
|5|{{{sortField}}}|Alternate sort field. By example : "index".|Sorts tags and tiddlers alphabetically (on their title)|
|6|{{{labelField}}}|Alertnate label field. By example : "label".|Displays tiddler's title|
!Useful addons
*[[FieldsEditorPlugin]] : //create//, //edit//, //view// and //delete// commands in toolbar <<toolbar fields>>.
*[[TaggerPlugin]] : Provides a drop down listing current tiddler tags, and allowing toggling of tags.
!Advanced Users
You can change the global defaults for TagsTreePlugin, like default {{{level}}} value or level styles, by editing or overriding the first config.macros.tagsTree attributes below.
!Code
***/
//{{{
config.macros.tagsTree = {
expand : "+",
collapse : "–",
depth : 6,
level : 1,
sortField : "",
labelField : "",
styles : ["h1","h2","h3","h4","h5","h6"],
trees : {}
}
config.macros.tagsTree.handler = function(place,macroName,params,wikifier,paramString,tiddler)
{
var root = params[0] ? params[0] : (tiddler ? tiddler.title : null);
var excludeTag = params[1] ? params[1] : "excludeTagsTree";
var level = params[2] ? params[2] : config.macros.tagsTree.level;
var depth = params[3] ? params[3] : config.macros.tagsTree.depth;
var sortField = params[4] ? params[4] : config.macros.tagsTree.sortField;
var labelField = params[5] ? params[5] : config.macros.tagsTree.labelField;
var showButtons = (level>0);
var id = config.macros.tagsTree.getId(place);
if (config.macros.tagsTree.trees[id]==undefined) config.macros.tagsTree.trees[id]={};
config.macros.tagsTree.createSubTree(place,id,root,excludeTag,[],level>0 ? level : 1,depth, sortField, labelField,showButtons);
}
config.macros.tagsTree.createSubTree = function(place, id, root, excludeTag, ancestors, level, depth, sortField, labelField,showButtons){
var childNodes = root ? this.getChildNodes(root, ancestors) : this.getRootTags(excludeTag);
var isOpen = (level>0) || (!showButtons);
if (root && this.trees[id][root]!=undefined) isOpen = this.trees[id][root];
if (root && ancestors.length) {
var t = store.getTiddler(root);
if (childNodes.length && depth>0) {
var wrapper = createTiddlyElement(place , this.styles[Math.min(Math.max(ancestors.length,1),6)-1],null,"branch");
if (showButtons) {
b = createTiddlyButton(wrapper, isOpen ? config.macros.tagsTree.collapse : config.macros.tagsTree.expand, null, config.macros.tagsTree.onClick);
b.setAttribute("treeId",id);
b.setAttribute("tiddler",root);
}
createTiddlyText(createTiddlyLink(wrapper, root),t&&labelField ? t.fields[labelField] ? t.fields[labelField] : root : root);
}
else
createTiddlyText(createTiddlyLink(place, root,false,"leaf"),t&&labelField ? t.fields[labelField] ? t.fields[labelField] : root : root);
}
if (childNodes.length && depth) {
var d = createTiddlyElement(place,"div",null,"subtree");
d.style.display= isOpen ? "block" : "none";
if (sortField)
childNodes.sort(function(a, b){
var fa=a.fields[sortField];
var fb=b.fields[sortField];
return (fa==undefined && fb==undefined) ? a.title < b.title ? -1 : a.title > b.title ? 1 : 0 : (fa==undefined && fb!=undefined) ? 1 :(fa!=undefined && fb==undefined) ? -1 : fa < fb ? -1 : fa > fb ? 1 : 0;
})
for (var cpt=0; cpt<childNodes.length; cpt++)
this.createSubTree(d, id, childNodes[cpt].title, excludeTag, ancestors.concat(root), level-1, depth-1, sortField, labelField, showButtons);
}
}
config.macros.tagsTree.onClick = function(e){
var id = this.getAttribute("treeId");
var tiddler = this.getAttribute("tiddler");
var n = this.parentNode.nextSibling;
var isOpen = n.style.display != "none";
if(config.options.chkAnimate && anim && typeof Slider == "function")
anim.startAnimating(new Slider(n,!isOpen,null,"none"));
else
n.style.display = isOpen ? "none" : "block";
this.firstChild.nodeValue = isOpen ? config.macros.tagsTree.expand : config.macros.tagsTree.collapse;
config.macros.tagsTree.trees[id][tiddler]=!isOpen;
return false;
}
config.macros.tagsTree.getChildNodes = function(root ,ancestors){
var childs = store.getTaggedTiddlers(root);
var result = new Array();
for (var cpt=0; cpt<childs.length; cpt++)
if (childs[cpt].title!=root && ancestors.indexOf(childs[cpt].title)==-1) result.push(childs[cpt]);
return result;
}
config.macros.tagsTree.getRootTags = function(excludeTag){
var tags = store.getTags(excludeTag);
tags.sort(function(a,b) {return a[0].toLowerCase() < b[0].toLowerCase() ? -1 : (a[0].toLowerCase() == b[0].toLowerCase() ? 0 : +1);});
var result = new Array();
for (var cpt=0; cpt<tags.length; cpt++) {
var t = store.getTiddler(tags[cpt][0]);
if (!t || t.tags.length==0) result.push(t ? t : {title:tags[cpt][0],fields:{}});
}
return result;
}
config.macros.tagsTree.getId = function(element){
while (!element.id && element.parentNode) element=element.parentNode;
return element.id ? element.id : "<html>";
}
config.shadowTiddlers.TagsTreeStyleSheet = "/*{{{*/\n";
config.shadowTiddlers.TagsTreeStyleSheet +=".leaf, .subtree {display:block; margin-left : 0.5em}\n";
config.shadowTiddlers.TagsTreeStyleSheet +=".subtree {margin-bottom:0.5em}\n";
config.shadowTiddlers.TagsTreeStyleSheet +="#mainMenu {text-align:left}\n";
config.shadowTiddlers.TagsTreeStyleSheet +=".branch .button {border:1px solid #DDD; color:#AAA;font-size:9px;padding:0 2px;margin-right:0.3em;vertical-align:middle;text-align:center;}\n";
config.shadowTiddlers.TagsTreeStyleSheet +="/*}}}*/";
store.addNotification("TagsTreeStyleSheet", refreshStyles);
config.shadowTiddlers.MainMenu="<<tagsTree>>"
config.shadowTiddlers.PageTemplate = config.shadowTiddlers.PageTemplate.replace(/id='mainMenu' refresh='content' /,"id='mainMenu' refresh='content' force='true' ")
//}}}
/*{{{*/
.leaf, .subtree {
display:block;
margin-left : 0.5em
}
.subtree {
margin-bottom:0.5em
}
#mainMenu {
text-align:left
}
.branch {
border:1px solid #DDD;
color:#AAA;
font-size:12px;
padding:0 2px;
margin-right:0.3em;
vertical-align:middle;
text-align:left;
}
.button {
border:1px solid #DDD;
font-size:12px;
padding:0 2px;
margin-right:0.7em;
vertical-align:
middle;
text-align:center;
}
/*}}}*/
The //Text// property specifies the text displayed in a Control. This property is __read-only__.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |[[ComboBox]]<br />~DateField<br />~FileControl<br />~FormattedField<br />~PatternField<br />~TextField<br />~TimeField |[[ComboBox]]<br />~DateField<br />~FormattedField<br />~PatternField<br />~TextField<br />~TimeField |A control on an open form |
!!!Syntax
//control//{{{.pText}}}
!!!Returned values
{{{String}}}
!!!Remarks
To set the text contained in a Control, use the [[Value]] property.
!!!Error messages
|Property '~Text' not applicable in this context |
!!!See also
[[Value]]
!!!Example
<<tiddler "Text example">>
Display the text as displayed in a DATEFIELD control (depends on the regional settings)
//{{{
Dim ofForm As Object, ocDate As Object, vValue As Variant, sText As String
Set ofForm = OpenForm("myForm")
ocDate = ofForm.Controls("myDateField")
sText = ocDate.Text
vValue = ocDate.Value
MsgBox sText & " - " & Day(vValue) & "/" & Month(vValue) & "/" & Year(vValue)
//}}}
The //~TextAlign// property specifies the text alignment in a Control.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] |~CheckBox<br />[[ComboBox]]<br />~CommandButton<br />~CurrencyField<br />~DateField<br />~FixedText<br />~FormattedField<br />[[ListBox]]<br />~NumericField<br />~PatternField<br />[[RadioButton]]<br />~TextField<br />~TimeField | All |A control on an open form |
!!!Syntax
//control//{{{.TextAlign}}}
//control//{{{.TextAlign = }}}//value//
!!!Returned values / Arguments
{{{Integer}}} or {{{Long}}}
!!!Remarks
The allowed values for ~TextAlign are:
>0: Left
>1: Center
>2: Right
!!!Error messages
|Property '~TextAlign' not applicable in this context |
|Value '...' is invalid for property '~TextAlign' |
!!!See also
[[FontBold]]
[[FontItalic]]
[[FontName]]
[[FontSize]]
[[FontUnderline]]
[[FontWeight]]
[[ForeColor]]
!!!Example
<<tiddler "Font example">>
Next people have indirectly contributed to the birth of the ~Access2Base API:
*''Bernard Marcelly'' because I would have abandoned the project without the existence of ~XRayTool, the inspector of API objects, See [[here|http://bernard.marcelly.perso.sfr.fr/index2.html]].
*''Jeremy Ruston'' who developed the remarkable personal wiki which served as template for the documentation of ~Access2Base. See [[TiddlyWiki, a reusable non-linear personal web notebook|http://www.tiddlywiki.com/]].
*''Andrew Pitonyak'' I found a number of promising examples in [[Base Macro programming|http://www.pitonyak.org/database/AndrewBase.pdf]].
*''Roberto Benitez'', his [[BaseTools|http://extensions.services.openoffice.org/en/project/BaseTools]] extension was a first step in the direction of the implementation of an ~MSAccess-like API. A few snippets in my code are inspired by his work.
*''DACM'', after a few database corruptions I was very happy to discover his posts on the ~OpenOffice forum (see a.o. [[Avoid data loss by avoiding "Embedded databases"|http://user.services.openoffice.org/en/forum/viewtopic.php?p=162653#p162653]]) !!
Many thanks to all of them.
/***
|''Name:''|TiddlersBarPlugin|
|''Description:''|A bar to switch between tiddlers through tabs (like browser tabs bar).|
|''Version:''|1.2.5|
|''Date:''|Jan 18,2008|
|''Source:''|http://visualtw.ouvaton.org/VisualTW.html|
|''Author:''|Pascal Collin|
|''License:''|[[BSD open source license|License]]|
|''~CoreVersion:''|2.1.0|
|''Browser:''|Firefox 2.0; InternetExplorer 6.0, others|
!Demos
On [[homepage|http://visualtw.ouvaton.org/VisualTW.html]], open several tiddlers to use the tabs bar.
!Installation
#import this tiddler from [[homepage|http://visualtw.ouvaton.org/VisualTW.html]] (tagged as systemConfig)
#save and reload
#''if you're using a custom [[PageTemplate]]'', add {{{<div id='tiddlersBar' refresh='none' ondblclick='config.macros.tiddlersBar.onTiddlersBarAction(event)'></div>}}} before {{{<div id='tiddlerDisplay'></div>}}}
#optionally, adjust StyleSheetTiddlersBar
!Tips
*Doubleclick on the tiddlers bar (where there is no tab) create a new tiddler.
*Tabs include a button to close {{{x}}} or save {{{!}}} their tiddler.
*By default, click on the current tab close all others tiddlers.
!Configuration options
<<option chkDisableTabsBar>> Disable the tabs bar (to print, by example).
<<option chkHideTabsBarWhenSingleTab >> Automatically hide the tabs bar when only one tiddler is displayed.
<<option txtSelectedTiddlerTabButton>> ''selected'' tab command button.
<<option txtPreviousTabKey>> previous tab access key.
<<option txtNextTabKey>> next tab access key.
!Code
***/
//{{{
config.options.chkDisableTabsBar = config.options.chkDisableTabsBar ? config.options.chkDisableTabsBar : false;
config.options.chkHideTabsBarWhenSingleTab = config.options.chkHideTabsBarWhenSingleTab ? config.options.chkHideTabsBarWhenSingleTab : false;
config.options.txtSelectedTiddlerTabButton = config.options.txtSelectedTiddlerTabButton ? config.options.txtSelectedTiddlerTabButton : "closeOthers";
config.options.txtPreviousTabKey = config.options.txtPreviousTabKey ? config.options.txtPreviousTabKey : "";
config.options.txtNextTabKey = config.options.txtNextTabKey ? config.options.txtNextTabKey : "";
config.macros.tiddlersBar = {
tooltip : "see ",
tooltipClose : "click here to close this tab",
tooltipSave : "click here to save this tab",
promptRename : "Enter tiddler new name",
currentTiddler : "",
previousState : false,
previousKey : config.options.txtPreviousTabKey,
nextKey : config.options.txtNextTabKey,
tabsAnimationSource : null, //use document.getElementById("tiddlerDisplay") if you need animation on tab switching.
handler: function(place,macroName,params) {
var previous = null;
if (config.macros.tiddlersBar.isShown())
story.forEachTiddler(function(title,e){
if (title==config.macros.tiddlersBar.currentTiddler){
var d = createTiddlyElement(null,"span",null,"tab tabSelected");
config.macros.tiddlersBar.createActiveTabButton(d,title);
if (previous && config.macros.tiddlersBar.previousKey) previous.setAttribute("accessKey",config.macros.tiddlersBar.nextKey);
previous = "active";
}
else {
var d = createTiddlyElement(place,"span",null,"tab tabUnselected");
var btn = createTiddlyButton(d,title,config.macros.tiddlersBar.tooltip + title,config.macros.tiddlersBar.onSelectTab);
btn.setAttribute("tiddler", title);
if (previous=="active" && config.macros.tiddlersBar.nextKey) btn.setAttribute("accessKey",config.macros.tiddlersBar.previousKey);
previous=btn;
}
var isDirty =story.isDirty(title);
var c = createTiddlyButton(d,isDirty ?"!":"x",isDirty?config.macros.tiddlersBar.tooltipSave:config.macros.tiddlersBar.tooltipClose, isDirty ? config.macros.tiddlersBar.onTabSave : config.macros.tiddlersBar.onTabClose,"tabButton");
c.setAttribute("tiddler", title);
if (place.childNodes) {
place.insertBefore(document.createTextNode(" "),place.firstChild); // to allow break line here when many tiddlers are open
place.insertBefore(d,place.firstChild);
}
else place.appendChild(d);
})
},
refresh: function(place,params){
removeChildren(place);
config.macros.tiddlersBar.handler(place,"tiddlersBar",params);
if (config.macros.tiddlersBar.previousState!=config.macros.tiddlersBar.isShown()) {
story.refreshAllTiddlers();
if (config.macros.tiddlersBar.previousState) story.forEachTiddler(function(t,e){e.style.display="";});
config.macros.tiddlersBar.previousState = !config.macros.tiddlersBar.previousState;
}
},
isShown : function(){
if (config.options.chkDisableTabsBar) return false;
if (!config.options.chkHideTabsBarWhenSingleTab) return true;
var cpt=0;
story.forEachTiddler(function(){cpt++});
return (cpt>1);
},
selectNextTab : function(){ //used when the current tab is closed (to select another tab)
var previous="";
story.forEachTiddler(function(title){
if (!config.macros.tiddlersBar.currentTiddler) {
story.displayTiddler(null,title);
return;
}
if (title==config.macros.tiddlersBar.currentTiddler) {
if (previous) {
story.displayTiddler(null,previous);
return;
}
else config.macros.tiddlersBar.currentTiddler=""; // so next tab will be selected
}
else previous=title;
});
},
onSelectTab : function(e){
var t = this.getAttribute("tiddler");
if (t) story.displayTiddler(null,t);
return false;
},
onTabClose : function(e){
var t = this.getAttribute("tiddler");
if (t) {
if(story.hasChanges(t) && !readOnly) {
if(!confirm(config.commands.cancelTiddler.warning.format([t])))
return false;
}
story.closeTiddler(t);
}
return false;
},
onTabSave : function(e) {
var t = this.getAttribute("tiddler");
if (!e) e=window.event;
if (t) config.commands.saveTiddler.handler(e,null,t);
return false;
},
onSelectedTabButtonClick : function(event,src,title) {
var t = this.getAttribute("tiddler");
if (!event) event=window.event;
if (t && config.options.txtSelectedTiddlerTabButton && config.commands[config.options.txtSelectedTiddlerTabButton])
config.commands[config.options.txtSelectedTiddlerTabButton].handler(event, src, t);
return false;
},
onTiddlersBarAction: function(event) {
var source = event.target ? event.target.id : event.srcElement.id; // FF uses target and IE uses srcElement;
if (source=="tiddlersBar") story.displayTiddler(null,'New Tiddler',DEFAULT_EDIT_TEMPLATE,false,null,null);
},
createActiveTabButton : function(place,title) {
if (config.options.txtSelectedTiddlerTabButton && config.commands[config.options.txtSelectedTiddlerTabButton]) {
var btn = createTiddlyButton(place, title, config.commands[config.options.txtSelectedTiddlerTabButton].tooltip ,config.macros.tiddlersBar.onSelectedTabButtonClick);
btn.setAttribute("tiddler", title);
}
else
createTiddlyText(place,title);
}
}
story.coreCloseTiddler = story.coreCloseTiddler? story.coreCloseTiddler : story.closeTiddler;
story.coreDisplayTiddler = story.coreDisplayTiddler ? story.coreDisplayTiddler : story.displayTiddler;
story.closeTiddler = function(title,animate,unused) {
if (title==config.macros.tiddlersBar.currentTiddler)
config.macros.tiddlersBar.selectNextTab();
story.coreCloseTiddler(title,false,unused); //disable animation to get it closed before calling tiddlersBar.refresh
var e=document.getElementById("tiddlersBar");
if (e) config.macros.tiddlersBar.refresh(e,null);
}
story.displayTiddler = function(srcElement,tiddler,template,animate,unused,customFields,toggle){
story.coreDisplayTiddler(config.macros.tiddlersBar.tabsAnimationSource,tiddler,template,animate,unused,customFields,toggle);
var title = (tiddler instanceof Tiddler)? tiddler.title : tiddler;
if (config.macros.tiddlersBar.isShown()) {
story.forEachTiddler(function(t,e){
if (t!=title) e.style.display="none";
else e.style.display="";
})
config.macros.tiddlersBar.currentTiddler=title;
}
var e=document.getElementById("tiddlersBar");
if (e) config.macros.tiddlersBar.refresh(e,null);
}
var coreRefreshPageTemplate = coreRefreshPageTemplate ? coreRefreshPageTemplate : refreshPageTemplate;
refreshPageTemplate = function(title) {
coreRefreshPageTemplate(title);
if (config.macros.tiddlersBar) config.macros.tiddlersBar.refresh(document.getElementById("tiddlersBar"));
}
ensureVisible=function (e) {return 0} //disable bottom scrolling (not useful now)
config.shadowTiddlers.StyleSheetTiddlersBar = "/*{{{*/\n";
config.shadowTiddlers.StyleSheetTiddlersBar += "#tiddlersBar .button {border:0}\n";
config.shadowTiddlers.StyleSheetTiddlersBar += "#tiddlersBar .tab {white-space:nowrap}\n";
config.shadowTiddlers.StyleSheetTiddlersBar += "#tiddlersBar {padding : 1em 0.5em 2px 0.5em}\n";
config.shadowTiddlers.StyleSheetTiddlersBar += ".tabUnselected .tabButton, .tabSelected .tabButton {padding : 0 2px 0 2px; margin: 0 0 0 4px;}\n";
config.shadowTiddlers.StyleSheetTiddlersBar += ".tiddler, .tabContents {border:1px [[ColorPalette::TertiaryPale]] solid;}\n";
config.shadowTiddlers.StyleSheetTiddlersBar +="/*}}}*/";
store.addNotification("StyleSheetTiddlersBar", refreshStyles);
config.refreshers.none = function(){return true;}
config.shadowTiddlers.PageTemplate=config.shadowTiddlers.PageTemplate.replace(/<div id='tiddlerDisplay'><\/div>/m,"<div id='tiddlersBar' refresh='none' ondblclick='config.macros.tiddlersBar.onTiddlersBarAction(event)'></div>\n<div id='tiddlerDisplay'></div>");
//}}}
(Q) Some of the records in my database have values that are longer than the width of the bound control on the form. Is there a way I can display the complete text without requiring the user to click in the field and using arrow keys to read the value ?
(R) Form controls have a property called [[ControlTipText]] (what you see in the yellow tooltip popup if you place the mouse over a control for some time). This property can be easily used to display the complete value of the actual control itself.
!!!Solution
Fire next code from the //After record change// event of a form:
//{{{
Sub setTipText(poEvent As Object)
Dim ofForm As Object, ocControl As Object, i As Integer, sValue As String
Const cstMin = 10
Const cstMax = 200
Set ofForm = Events(poEvent).Source
For i = 0 To ofForm.Controls.Count - 1
Set ocControl = ofForm.Controls(i)
sValue = CStr(ocControl.Value)
If Len(sValue) > cstMin Then
If Len(sValue) > cstMax Then
ocControl.ControlTiptext = Left(sValue, cstMax)
Else
ocControl.ControlTiptext = sValue
End If
End If
Next i
End Sub
//}}}
You will have noted that the tip text is modified only if long enough and truncated if the value is too long.
(Almost) all examples below require a prior installation of ~Access2Base to run satisfactorily.
Most examples have been implemented in a database that can be ''downloaded [[HERE|http://www.access2base.com/_howtos/TT NorthWind.zip]].''
#Download the file.
#Unzip all the files in one single directory of your choice.
#//Open// the ''"TT ~NorthWind.odb"'' Base file, //enable// macros, __//save//, //close// and //reopen// the file__.
#//Close// above file, //open// the ''"TT ~NorthWind ~StandAlone.odt"'' Writer file, //enable// macros - no data will be displayed -, __//save//, //close// and //reopen// the file__.
#All forms, queries, Basic code in those files refer to one or more of next examples.
!!Generalities
#[[Mix Access2Base and UNO objects in the same code|MixAccess2baseAndUNO]]
#[[Manipulate the database window|DatabaseWindow]]
#[[More about the shortcut notation|ShortcutNotationMore]]
#[[DLookup usage samples|DLookupSamples]]
!!About Forms
#[[Find out if a form is open|FindOutFormOpen]]
#[[Enumerate all controls on a form|EnumerateControls]]
#[[Simulate calculated fields|CalculatedField]]
#[[Use a (Multi-select) listbox to select the data displayed in a form|MultiSelectListboxSelectForm]]
#[[Fill Fields automatically on form based on a control's value|FillAutoControlValue]]
#[[Carry current value of a control to new records|CarryToNewRecord]]
#[[Browse recursively thru all controls of a form/subform|BrowseThruControls]]
#[[Use Variables in SQL behind forms|UseVariablesInSQL]]
#[[Use ControlTipText to display textbox value|TipTextForLongValues]]
#[[Ask before saving record|AskBeforeSaving]]
#[[Limit content of combo/list boxes|Sync2Combos]]
#[[Zoom on image|ZoomOnImage]]
#[[Adding "All" to a list- or combobox|AddAllToBox]]
#[[Keep several linked forms synchronized|KeepFormsSynchro]]
#[[Simulate a Google search box|SelectListboxOnFirstLetters]]
/***
|Name|ToggleSideBarMacro|
|Created by|SaqImtiaz|
|Location|http://tw.lewcid.org/#ToggleSideBarMacro|
|Version|1.0|
|Requires|~TW2.x|
!Description:
Provides a button for toggling visibility of the SideBar. You can choose whether the SideBar should initially be hidden or displayed.
!Demo
<<toggleSideBar "Toggle Sidebar">>
!Usage:
{{{<<toggleSideBar>>}}} <<toggleSideBar>>
additional options:
{{{<<toggleSideBar label tooltip show/hide>>}}} where:
label = custom label for the button,
tooltip = custom tooltip for the button,
show/hide = use one or the other, determines whether the sidebar is shown at first or not.
(default is to show the sidebar)
You can add it to your tiddler toolbar, your MainMenu, or where you like really.
If you are using a horizontal MainMenu and want the button to be right aligned, put the following in your StyleSheet:
{{{ .HideSideBarButton {float:right;} }}}
!History
*23-07-06: version 1.0: completely rewritten, now works with custom stylesheets too, and easier to customize start behaviour.
*20-07-06: version 0.11
*27-04-06: version 0.1: working.
!Code
***/
//{{{
config.macros.toggleSideBar={};
config.macros.toggleSideBar.settings={
styleHide : "#sidebar { display: none;}\n"+"#contentWrapper #displayArea { margin-right: 1em;}\n"+"",
styleShow : " ",
arrow1: "«",
arrow2: "»"
};
config.macros.toggleSideBar.handler=function (place,macroName,params,wikifier,paramString,tiddler)
{
var tooltip= params[1]||'toggle sidebar';
var mode = (params[2] && params[2]=="hide")? "hide":"show";
var arrow = (mode == "hide")? this.settings.arrow1:this.settings.arrow2;
var label= (params[0]&¶ms[0]!='.')?params[0]+" "+arrow:arrow;
var theBtn = createTiddlyButton(place,label,tooltip,this.onToggleSideBar,"button HideSideBarButton");
if (mode == "hide")
{
(document.getElementById("sidebar")).setAttribute("toggle","hide");
setStylesheet(this.settings.styleHide,"ToggleSideBarStyles");
}
};
config.macros.toggleSideBar.onToggleSideBar = function(){
var sidebar = document.getElementById("sidebar");
var settings = config.macros.toggleSideBar.settings;
if (sidebar.getAttribute("toggle")=='hide')
{
setStylesheet(settings.styleShow,"ToggleSideBarStyles");
sidebar.setAttribute("toggle","show");
this.firstChild.data= (this.firstChild.data).replace(settings.arrow1,settings.arrow2);
}
else
{
setStylesheet(settings.styleHide,"ToggleSideBarStyles");
sidebar.setAttribute("toggle","hide");
this.firstChild.data= (this.firstChild.data).replace(settings.arrow2,settings.arrow1);
}
return false;
}
setStylesheet(".HideSideBarButton .button {font-weight:bold; padding: 0 5px;}\n","ToggleSideBarButtonStyles");
//}}}
|~ViewToolbar|closeTiddler closeOthers +editTiddler > permalink references|
|~EditToolbar|+saveTiddler -cancelTiddler deleteTiddler|
!!!Role
Display a dialog box for error handling settings and registered errors viewing. This routine is typically called from a button or a menu item.
[img[TraceLog Dialog.png]]
!!!Syntax
~TraceConsole has no arguments.
{{{TraceConsole()}}}
!!!User interface
| !Control | !Description |
|Clear the list |All the entries are erased from the list. |
|Set minimal trace level |All the calls for logging an event (TraceLog) having a level below the indicated level are ignored. |
|Set max number of entries |Determines the size of the circular buffer containing the logged events. When changed the existing list is always erased. |
|Dump to file |Open a File Save As ... window to save all the current entries in APPEND mode to a text file. |
!!!Remarks
The //~TraceConsole// function is executed when in the IDE the menu item {{{Tools + Add-Ons + Access2Base Console ...}}} is activated.
!!!See also
[[DebugPrint]]
[[Error Handler]]
[[TraceError]]
[[TraceLog]]
!!!Role
Manages errors:
- registers the error in the error logging circular buffer
- informs the end-user
- stops the program or continues
!!!Syntax
{{{TraceError(TraceLevel, ErrorCode, ErrorProcedure, ErrorLine)}}}
!!!Arguments
| !Argument | !Type | !Description |
|~TraceLevel | String |The level of the occurred event. See [[error handling generalities|Error Handler]] for more details.<br />The call to ~TraceError is __ignored__ if the given level is lower than the current minimal trace level. |
|~ErrorCode | Integer |The numeric code of the error. Normally the output of the AOO/~LibO Basic Err function. |
|~ErrorProcedure | String |The name of the procedure where the error occurred. |
|~ErrorLine | Integer |The line number where the error occurred. |
!!!See also
[[DebugPrint]]
[[Error Handler]]
[[TraceConsole]]
[[TraceLog]]
!!!Example
<<tiddler "TraceError example">>
!usage
{{{[img[TraceError Msgbox.png]]}}}
[img[TraceError Msgbox.png]]
!notes
//none//
!type
image/png
!file
./TraceError Msgbox.png
!url
!data
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAWUAAABuCAIAAABwV5WbAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAHvVJREFUeF7tnQl8FEW+xyuESwRcRFhZFBa5EZBwyGW4bxIIgQBRjoCGIyGwRnfXdT2e5qM+RHkguruK7hPddYUlIIoakPVJFkWRS44YsgmZzH3kmMlJQqDev7p6unvuyWTCMOHfn/8n9FRXV1f/uurb//pXdxNBKSWKJSLmdEREJCTQq21YcmSEuLF1W7beJpK0jCT11+BvRGQkvUZJ/XXSogVpQch1eyn18AMXfxRgOuPiQ4GIOpTItwJU2ZZg/ZrDLrX8FyjZmtTVk9ZCX61rQVq3ZGmkntlVoae3Ahq0FDK3JFcpqTXSb4Y4FAW84EtEzFmw1msr26Rf6/w0/dWLzHq/RPu/TqNeo1Fv0nHbmUW/xWzinz0az4DmUwEvGuImSQGfMmIGt10SEnlvlf7y/utqrHc7GvR6MIBA6w31ZOI5EvWdRAkiwaLFchPAosUGW5snr0NWCRm9NlMwoMb922QDfHBTJuI6KoAKhEQB6J7c+NH5Ou/2/JbPe7FkkKj8yZ0DyXj3B2uz6RoYWVpBxp/joGC8IJNPkDg1WZgXkWwBI2tLuAE7IjdWRW6qA4KQJ65FplMwvg5/pUS+whNbP34d3BOeEw0VaLwCERuuo/lUAHSGPLyT8s7ILSKlrkVybeS6yshkW0RSFVlZTh4W/j5SDj/FlKRSwm1ZMfsLWxPMZKmFGaSALdKQqedJdL6CF3NPkYcLZVthIKtNnB1ADW6MHR6MbYU6SZZsg/qhoQKoQMgUeLQ4EmyVJWKVGYYOYORhA1mqZ5agEw1AwG1hEbM4FVhEbD6ZA5ZLZv7MDFYAFqN/JHf/U4h1Dj/KNgMvFuaJxsEhIEOihuh0rC8nktndENjEyKKkFMcSmg8FTGQZGioQJAUAB04moKHVYs2aHSZd8VUpBuHnyppXVa0mnSLRJxksgBJgXd4XeAE2+QQEOz3xgo9TlEMVzgiWAm7IKjNZYWIGrZ/XmGMMDRVABW6MApKnwH0H/hOCDHGqNdsNdUX5li1PmP6YZHg8QZ8Sq1szS7tqivbRadqVE8A0y8aDqRePYLZwmCp2QP70nmcXjizLPbfmlUIIdjI+DPqS9Nsr8KLPR+54oVX6FxIvJEYoMGFgOSWwOTk8kueDK64KSNcYV7wowF1lND8VkMYXAixgcAHeRPHrvyv7cJv1ozdL33nJ8vpvza9sNL+wzvT8GtMzq41/WGn8wwrjbxMN6Yv1G+N062ZrkyaqEoafndH7i7nDdOZakRf3HWKg6PgsgWEJ40X0yRbTlf4F4wVzHLj7IMQymK0yy4lKh0LpU2DrRwWCqICf/QSzsegDzFpAGAJIwWAh8cL0fLJ1959te98pfW9z8fanLVvSzS+lmV5YZ3wuGZBh+uMq4++XG59M1G+K16XEaB+dWpQ4+tycAXtGdGEBC/AvBn9PXHnBYhsQwmDBC8G5WMFIIRkPnPDYiTwAcTsGQVfCTwWC2KmacVEIAn8UEBnBSWHnxVwVmauCPm98cimQomzX6yVvPW959XFzRorp2ceMT60wPJFo2LRIn7ZAt26ubt0cNkJJmqhZNk61eOS5mEF7H7yb8QKCF8CLX3+v8C8AIfBUBgRCgUnQ8sBZgEiEEJJQ8kIZa2XhVrf+hZ9dBbOhAqhAEBVYoFOQQk1iNczsvDBsii/e/ofiHc8ALGpOZgMFDOmJhrSFunWx2sdmaFdO1jwyTpM4BtIrvspUJ0QVLhx2ft7gzHH3Ml48eE7kBcQv2HjkV0cYQsYDL/KZMwPnALzYXGl2jKKaj8EMbfkFZWJJZTqfpHm4zCG9uDxdIUR6thyYNWeb7HM5pV52ked7gigoFhWmCkBPQPNfAU4KR15AjNPyykbLq78Bz0LqwQIsZmpXTgJYqBePlNLV8UMK44eej3XhhRi/AF4AQiYJk67gXECrSjRyXpgPv9/u7gzJyCwT6+QXsiCFdMli65YihoxEq5t0oXUKsLh6+Nm32S7ppxiDcvj0r8ALp6LCtEFjtVGBkCsgAcUdL3TJMyBawYYhzyUbf79CQoN21VTt8mjN0gdlWMzrr44bpFow+HzsoMyx94j+xcCzbDwi+xcSL+CoIi+qOS/ILBV76uPR4laPlpJHK3knJ9FnIpcX77wEPwp3Dv2GLBf8DkgfcwrmUMX0+49wKJi/3k+6vE3mCfj4porSssNP/SjxgoyCdZ1iF/uTJCG/AFgBVCDsFID+KzsX8ngEeGF8OskIsyHw98lHDBsXSYCAaIUMi9g+6rn3qWP7quIGXogZuG9sd8aLUbnEPS8gTAKzoeBcQPBis8QLDZCCm3tedNnvwItEo9j5u+wj/7jCMPJuBplUwJ4wBRNT3iHzbCJiRp2GdHkXng0NFUAFAlBA8jLmGuxDEg30Qc3yh2D6g02C/G45RC70mxbqUuc5PbWlXdBfO7+3JubXmtj7iub3vTin7/7R3URegD8ByIBHMFj8AjyNMblkhpaNEvlz4/BU4ms1ivjFtcNbbfAqGll7xe5fnCNJ1Ww9J4s48OIMSRR8DZa+Lz27ntLKw+kZZI7wLDrYK1Wi2zJHckkcdiGJ9pw8f/O2ABoE7oIKeFFggYU4GHM3GC8SRxvSFhjTlxhhQuTxJfqN8eyprbUz5VjGksG6hf10cffpYnvoYnuq5/XKmd1r/6iujBfjLokuBoxHOm9x5AWHBTzZvaVWGb8gXd4jK+28kA6SpyFdMkj0BZEdUvolNUsfc07gRfnh9HdJfClZKtgrDENsmDPF4hDvtO8iZuOZ0VABVMB/BRJsRDIFNaBfqhcN162fa/jNIsPji42/SYDpEv2GWCf/wpDQzxDfSz/vHn3sPZqYe3Jm3PPJiDsZL8arGC965zD/gvGi5zl484z5FzBa47yAF9Req7M7Ambh/ba61im1JOWq6F+Iwc5T6dG5kauqSVKtc/qYi/ACHPmYzYxcePddsoi9D6dIySDTStzvwrOhoQKSAvAyNVqDFJCpYSULrNAHi+bfD89W6FPnASkMmxbqNy6QYGFIjubr16tsxkW9jHHdDbF3a+fc/fOUrp9G3cF4MamIIWNoPuNFlzcEXsBvxguzCAvgxdZ6kRcxFoCFMy+m5JF9FVCW+ch5klwr8yL6Z7KnXEiHAUuVDJ049uYs2M482GjaCd5HnB0xjrvwbLeIsTeL0VCBoCvA4WKnBnQ51dy+mhXRurWz9Bvm6dPiZFism2JIfsi4Wp4fMcV1M8Z01c7snDvxFweGtGO8mGwk49UKXoCnwXhhZiMfIMVK9mK8zIu44hYp1yNTr7Iv7aRdE52CafnwUwhSlh1+0UKS7X7HpDxgx85cIf2/zGyd5xHWyZ5rDCVfv0+6fE6S7LtEO+/CcqKhAqhAgxRYVksk4wBiyKgEg05XOL2HeumD2tVTdGtnS7DQr5tuWDvZ8Nh44+pR5hVDpHTTnE76aR1+Hn/7gftbM14AGTgy2Pup4F9wXkBAFQYjAizYEEPwL5SL+Xg92XTdzosC9tUd/pNqd66mYjrMgyRfE/EB6ctrIx6r3ZkjF3PhH5+zBzHmmJWIgTxOu0AKGirAFSBJ9Wh+KMDvsqCVsMLZkXiFLK2B7nd50t1FC4bC1Ckgo+ro55CiT56qT56sfyzasHqMMWm4adkgc2IfSK/J2mWa1VE36bafH2z1Sf8WjBczyxgvxpjZU5728YiazIXJCPZpHeAFD1iQR09A2NLhea1FpeTJyyyWOaMAvqMFRtKFn12ySJqwMuUyOCNgJMWezn9OUTz0lchS5DweduF50FAB4Q6E1hAFJMIK1IA+X/DQXTAkKVoUpXlkrHZFtHZltHbFeN2KsboVo/XLhxseGWxc0te0qCcMRsC5ME67XRvdKmdEi/39IkRegIsBvIC3RhgvfnWGORsCL7hzwXnBxiDwJb5N1zga4Ct7/Bt8kvF0+YNrG2mk3bCVowKowI1XwAGsdmpAn88d3fE/U+8piBlwOf6BwoQRqiUjVQlRqsVRRYuHqhMGaRf21cb11MV0083qrJvaQTuhjWpMi58eIHt6Cx/rjKlgLgbwQhyPOPKCI0OMcW6o5x/8ZLBw4QX/WqcnZEjswBVPCtz49oRHbPYKuCJDV3Lt1OwBJ8d0Pjmh+5lpvc7M7HtmZr8zM/qcndn7pxm9zk3vcXF694tTuuZM6nwxumPO2Nsujmr507CI7EHknw/1dOYFm09V8IJ/BZS7GNI0KoQ2HaiRLnocnmDR7C8JniAqcHMq4DxwE1yMNX+uKM05+/m0AR/d32HvsE7/jLpz9/C7dg+7c+/wzpnDO++L+sWBYR0+Hdru4JC2Bwa1PjAg8mD/iH19yN6HepovnFmzw+bgX9h5AfFOIX4Bk97C38gkGzPmaMBXfNnDF6JtqAd8gMFoxdW4iNw3QfOpAA7LUYEgKyCOQewzjEL8otUj1Wv+xJ5yaNCiK65fs83Wan45G4zw+AWMRxx4AW+qwPup4ucG7Q96riyXP3Cs/AL4ujr4VLmTwcnbY9o4J+qPAhj590cBf5S85fMAGgAWfE6ET6YuqYbJEWawAhOrC9jcKvvLVyRbYCUxZfBYl7gVohU8YOFkzrxgU6oq9i3gqWcipp2Fb/Oxz/PBF3QEg68AcmMf1AGsSN/wkT/+Zf+qj/J1WlxHBRqvwAx4OAjNlwLs0zga90JNzWdfqwCDx7i5TcgTf/J0MJ4Cf+FtETB4oYy/NgIr8Bfg4J4XU88wXgjIkKjB2eFkPAMzKb9iR3mrlA1XXBQAqdF8KiA2MN660Dwr4FPJwDPw58H5/EibkXldU0rbJhQUm3LRUAFUABVwVYCMzyO9dpPOryEvkJKoACrgQwHkBTYRVAAV8FcBmRe34XgEB2KoACrgVQEWJb33fTYeQV7geBUVQAW8KyDzom3UJYx3YnNBBVABLwogL/wduWEzQgVQAeQF8gIVQAX8VUDmRZuo3EaOR7QXX76U1QEMVpDEqAAq0PwUYLzoIcQ7G8kLs+6Hn79oX2P97xrrZliBn81PLDwjVOAWVyBovMj/Ls7ycyytfZvW/q8ldyH8vMWVxdNHBZqfAsHhhanoSO6Xt9WXv0grNtPK7fWVb+R+2Q4Sm59eeEaowK2sQHB4kXdsvunCNFr+HC17hlozaOX/mC7GQOKtrCyeOyrQ/BSQedE20HinLm9X7qFO9SXptOQJakmnxb+jZS/Ul72Ue+hO2NT8JMMzQgVuWQXIBHi+cxeLdwbMiwuHRpRcmk1LN9CyFGpdT63wN51any/JS4BNt6yyeOKoQPNTQOZFYPMj2ku7Ln7RkZYkU+uqf3+59IlNMWDHsh6htk3U+szFLzpBhuanGp4RKnBrKkCiC0gPwb8IjBdnv+hX9p+p1LyUWpemrpk8Tlg2rJ1CbUm0JK0sPx4y3JrK4lmjAs1PgUbxovCnl3OPdKOWBGpcQMviRygWWpZAzStp6cbcIz0gW/MTDs8IFbgFFZB5EUD84sd93Wz5k6gxhurm0JK5o0YOHSwssEJLYqg+nlpW2S7HQ7ZbUFk8ZVSg+SmgfH+kYc+D/+fHpy5mdaGmmVQ3lWqmUsu0uJhBfYQFVuAn1cyghnhasvrioe6Quflph2eECtxqCgT4vplJ+8N3H7e/op5AdROpZgItiqaWiWnJA3sIC6zAT1o0gWpnUGPCFd0SyAy7NF9xj2euJWTrwRCcYM5f16/966Ub85WX7AxCkjJz/H03qWnVCOzEA9vrxsjrdJSbsqrK5y8a8P2LnGMpef/XnerHU80YWjSaFo6m5rFbXuj/S2GBFfjJEovGUt0Mal6S901f2KVRDQjkI8olmA330p4M1g2yM7ZlKzvDwW3OXdE1heW/tCeJwcKxhmJRnq662/QAmkgAuzSm9QMybhievNfTnxN3zcNT/NnX5ejsKisXxe3h2FbiKItLO/HniIr2s37PcdacApa6yTpLILwAT+Hoh7fXqEZQzQhaNIIWDqeXh1PDiN07+3cSFliBnywRNqnHUv3sGs082KVRLkZj5PPRQ45nbmW36GNbM47Zc4qNQ3HBXFPs+Du4jd91lTUULpgjfZrmttyEsritMPOkbsR5+YSaPyfuiRc+C/eVAQDBurSQja1vzZD6tud24r0B2FsRK/PgNn77aQwvAt7X5/f4xPdTh/vrX5w+FFf4bU+qG0bVQ2nhEHpZMPXQH7IGtBcWWGGbeHrhA1T7EDXFFh4fDDsG7mJ4uPaZgHaScUzYKq7DCct8FRDgtFWhCLszOC5yZ/CztUm3XKf8ylsZq48EI2gZYoUBUvJdS3nf81h/VleH7sqOkrENRkNs4T6XsksrW6G4STpdVo58IBl5HmUUdIMKS11FvJpOteUt3n4YobaKn3sU3UAhka/raHcnlXdOxy6huP/LOvBayBV2uihim1Go6iSI286juJqiGm4vvXJf5zN1uY5MIvl2xYSVG63b6skNm41G5SrB1Zdbl9zdlF3A787i2luF+RH+Prt/vNAVHvnmg5ZXAQfqQbRwIL08kBYIphpoPD+gY4e2YLACP8V0yKB6gOomXdXN/eaDVrB7gMhwcrF475I6j8P9nLVO3qmUIwWPd0U+DMn56zb7HUPuBk6Qdod8uf84b3XgAoBJrADwRbp7KFoe827EErzW32lEwEoQ+xI7WV5hfgjlilO7FwtRtFGpQcs8cqkGL0QqXCzTNZuTD+L4U6mS60Gdr6O9C7ko4+32K9XQE/Fdj+tJEHe8kJwLj5fey3EleV1GduKtSxrmKKWQq+fYsO2UgZps28pH08JQqMk6i8wLP+dTf/xifkF2d6oBCvSnBf1ovsKMA/r0agtGjQMc0gvA3RhJDdMLjg2E3QPnhZfe69oK+ZXmHdJdP5eq4SF44Ti+kEpzcfP85IXUzY5tVQ5e+I3XsVc4nYtT/b3cymT6iCCQIeV0r5MGUA6+laNQrtVwK4L32trvk3JE1i0vJFWdS1PWz3P15Gttz88L9MkLp+M6dTOnG76yRbF1IcitXNyehVI0T61UeXVYUFmInfsUSqgeb07izYbv5XYs46WDKKvtq7M07H2zyxd2Hf2wzdWi/lTVh17uTQt603yFGfuOG9UWjBr7OqRDNvBENGOvaqcf/Vs7KCQQZHi69q6N2GcLli4PvzbKRTnH4f2I9kJ83GTkQgRHkePfuSnbqSHd97xcQr94wQbV27JdXFx7K/cYi/WOXbf+hU+1vVfYKfrovUd52cq6umLMEjAvfA37lZELJ2/fPRMbygtxNOcOju4IzjwLuNCs2kIDszvLzrGPkPDim90jtCd6UnU/WugCCwCHsW/83PZgzryATQV9adEDVD9FezIKCmlaXgijZefxiMd2IMSWQGsh5OlQMf94wRwHDwgQAwT2Q3OnURxL29FgHwTBxU7KzOZje6/199z9xMGX4mbrHGiQBmguQwl3QzD34xGX+EXDxyP2+7Y4gPJIAblk59AyPxHlNVUUIm+SHS77lVUS2c1xXY/o0iQ8OR0eKuMgrHfeKUci7jHq7orAOHqtGFECTxkamHPo3fsNtWGdJVfx/Qtf8YuC87v+tasN1UFswp1zIfBi3co7wNzxAlyM/mzy1TT7X7vaQVENRoazryj1Lvu4w+mCiV6DY1jIdTjqIXihnDyT0eMQw5NakmJ+RHZVXO510uDI4frJgUCHKTT5ZF3q78oL6aAOTBQA5PyshHw4cRCkVNWpjYoV5qVLoTh38yNOtXXYUQC34ijwU9JWnFbw4TU4DjHsLqFySkKap+BZlZt4UMBLvFO8SUh1cBLEocGwc3dFsBSb5EW5thw5gzfvSTm6cTfdJt2TlA1bdEbsF1p563Jwm4PUWUwN4cVXH/QznP41Vfd171wAL4AjMBIBgxXlOIWvF/ShRUOofpLh7INQVIN54drVb5oUhxv7TVKrJnpQoomKvUlEw2r4UsDf+MXF718+tvsOarifavrTIhiPuDPLACqZ2wwwpaIbSy1zju3pAgU2I2SE7vlODxfYfaTTV2vwcUVuquc7G3kuuHtACrDvX/D32b3Pjxx8p5sldwA1D6GGwVR3P9W6mHXIpx/2urf77WCwQq1D3OTRDabGUbRkhiVvIhTYjHjRNM9iBXRFUVVUoOkU8IsXZ48+lb2nE614kJYOp8VR1OzOqkf07tWpo7DACq0e4T5b8UhaNoVWLcre80sotulODEtGBVCBoCug5IX75zsN6h8y32hfWTKWVo+lFWOobTS1urP6sQP7//IuYYEVWj/WfTbbGFoxidbMryxdAMVC4UE/JSwQFUAFmkgB37z44VDKiawelE6l1ybSuom0doJ7o5OPfzly2NAeYLBC6WSPOesm02uxlK44kdUfCm+iE8NiUQFUIOgK+ObFnm23V9pmUjqH0tmCzfJskEcyL9mgkPnAi0rbCig86KeEBaICqEATKeCbFx+/3q4UPopDF1G6kNL4IFkCpatKTcug8CY6MSwWFUAFgq6Ab158vnvDP15r99GrJOgGxULhQT8lLBAVQAWaSAHfvLiUc/zrI/uOHNobdINiofAmOjEsFhVABYKugG9eBP2QWCAqgAqEqQLIC3zUChVABfxVAHnhr1JhekPAaqMCQVQAeYG8QAVQAX8VQF74q1QQIY1FoQJhqgDyAnmBCqAC/iqAvPBXqTC9IWC1UYEgKkAmFJB7xffZ/f3/BIJ4eCwKFUAFwkgB5AX6F6gAKuCvAsgLf5UKo5sAVhUVaCIFhO/x4XgEv2SFCqACfigg86JNFMYvwsbXMBkuagtPFxWcUOX/0KSWn5MddJMqDPVXF/wIJwKn00T3Qyw2uAogL8KGEcoLD31MX3T26bc+7rskgzz0ZJha19jn1r7yvlF7Diy4zRpLayIFkBdhyQu4LQMs+se+dNpAw9rgFP741m70L5qoewe9WORFuPICPIsjF6qbgcGJlJjzgt6yscCmUID9f8v38v+fHeMXfsR7muIaBFAmjPxhDHL4fNXh89X1bLnaeIuMbAmF+P+38Uc8fI7VH06krKQwABFwlxuvAPIiXP0L6GZfnq3M+qmyrq628daqVesGFdLQ/O4Kv5L1U1XW2So4EWup6sY3fTxiAAowXvRA/yJ8PAt+jSF+Ad3s4KmKz09XXLlSHY5WU1N18DSrP/IigH4bql2QF2HsXxz4sRysurqi8Xbbbe0bVEhD87sWXlXFKn/gZDnyIlSdP4DjIi/CmBeZ31szj9uqqwEZwTHNwVTpv/VOO1jIitUcSEs7oOHln9oBW/90KjjHqqqyZR637j1uRV4E0G9DtYvwfiqOR8JzPLL727KPv7NCx2u8tWvXUf1ZKkn7RC2W9v1bhKR9VlCl/iSNJ8IKSf1MLR4L8jfyoJWVVqg/GPIiVJ0/gOMiL8LYv/j70ZK/ZZdAxwuGff8mSflUpShKtT8tbb9K+uu0tdEHrago+/u/S/+eXYq8CKDfhmoX9r4Zf38E51NDdQ0COC6Pd77/dTEYdLzGW/uecamp+1UORR3fQbafUO1PTU1JZbBwOEr79r9o5EHLy0t3fV2y6+ti5EUADSBUuyAvwti/ePcr83tHLBUVpUEw1b7U1H0qh6K+20G2nYB0gMWn24jz1sYetLy85L2vLO9+ZUFehKrzB3BcmRdt8Xmt8IlicP/iL1nmv2SZoOM13jp0GLeDrD9QqCiqMDM1NbOQ/y0vKTywnuz4VjpQhw53NvKgNlvx20L9kRcB9NtQ7SJ8/0KIdyIvQnUNAjgu58WbB41vfma02UqCYgWfrCepmQViad++QUjqJ3m2AsYLITHvk1QhJUiHs1qL3zpoBENeBNAAQrWLzIs2UbldU0rbJhSEqip4XP8V4LzYfsCw/YAebtSNt44dO0MhDBn25Y3vhWJFXvBDHBMgcgnWef7GmNVq4fVHXvh/3UOeU/m+GfIibGIZnBdb9+u37tNBxwtHKyszQf1f369DXoScAv5XAHkRNoxQXlTOiy2ZWjCr1dx4u+OOLg0qpKH5XQsvKzWy+ou8KPK/yWLOECqA3+MLY15sztSCWSy6Ymb6Rlrnu7pBCf7/bczhoM4mYxGvP4DPVqoOYR/AQ/uvgMALjHeGz8wIv7Sayyfh41S8v4W7wYlU2PT+N1nMGUIFZF60GY7f7wwbX0NXdGbNy+/Dx6linz26/sXS8DU4hZQtH1RVWkLYB/DQ/ivAngfn/18R8sJ/1UKe06S/AHV49i97wv37nRte+1tlpbmmujTkkmIF/FEAeRE2PoXycsIH7OCbVBU2Q3VVSU112ZVq65WaJrG6uuqgm6Kq5bVXyq/U2MpKLvvTWDFPyBWQeYHPa4X8YmAFUIGbXAGMd4alf3GTtyqsXnNVAHmBvEAFUAF/FWC8wPdHmuvdAM8LFQiuAsgLf8kaXN2xNFQgHBWQeUG6nYGQ553xOv7WWZv5Zk9GZtnQUAFU4JZTAAYjQ74WxyOk6z72pCezXfYV/rNBBvt6sgaVI2SGkVIA5qXCXkrzWO1d3urgZS9v1YAyPZjHvbwI63mTp6N4Tw+w5gHVsGGtS2qfwWtjYoMPboENb+qstd+oVuGt0Xrvvx+y3t19J3tei9z1NvsHDRVABVABXwr8P3d+Zk4JJn1EAAAAAElFTkSuQmCC
Trap an error:
//{{{
Function ShowError()
On Local Error Goto Error_Function
Dim i As Integer, j As Integer
i = 10
j = i / 0
REM ...
Exit_Function:
Exit Function
Error_Function:
TraceError("ERROR", Err, "ShowError", Erl)
Goto Exit_Function
End Function ' ShowError
//}}}
The execution of
>{{{ShowError()}}}
will result in the display of next message to the user:
[img[TraceError Msgbox.png]]
!!!Role
Registers in the Traces circular buffer a new entry.
!!!Syntax
{{{TraceLog(TraceLevel, Text, [MessageBox])}}}
!!!Arguments
| !Argument | !Type | !Default | !Description |
|~TraceLevel | String ||The level of the occurred event. See [[error handling generalities|Error Handler]] for more details.<br />The call to ~TraceLog is __ignored__ if the given level is lower than the current minimal trace level. |
|Text | String ||Text to be recorded. |
|~MessageBox | Boolean | True |Indicates if the Text must also be displayed to the user in a message box. |
!!!See also
[[DebugPrint]]
[[Error Handler]]
[[TraceConsole]]
[[TraceError]]
!!!Example
<<tiddler "TraceLog example">>
!usage
{{{[img[TraceLog Dialog.png]]}}}
[img[TraceLog Dialog.png]]
!notes
//none//
!type
image/png
!file
!url
!data
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAqEAAAEZCAIAAAAosWuMAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAARp5JREFUeF7tnQt41NaZ9wU0Ibv7tN9u2eRpt0m6aZu2m7TZkN7SpqRp7k0gJReS0OZC0gLBhGTj7Xa/bZukLU+abkpZaEi3Xw2FdOk2JRhjsLEZCAFjg7HxfWxssMHX8f1+98zY33t0NBqNRmNGmhlpRvP38z7DoDnSkX460u+coyNpzszMjKD4m7O4dM6ceTRhxj2fTZ43R/rx0svY9/nzhA/MEzxe+pwzb96Md0bwTAtz5wpzBWHatxQP/Qd/IBBTAqyI4g8EYkhgzlQMF45Fg8CM8iRG370BSCb5/6gQXipMeYRLRb9OzRUu/QCbJnhYuEU7X0IG/4CY+AOCe0aY7Jg5+vmARZHj+d+cxeUUl64emZ/qXfCjmX/4OYtPvjbzmV/PLNwws3DLzNc2s1j0Fotv/HfI4AkQIBA7ArMUP/wEAlEhELvSiyWDgKZGaSI3rPzJnRsczMiBQaamIHFf+rxH+EalsPCEbHZBFvzcJztJ8HOfH5z/g2lKKmv+mv+coSDTX7/JH6R8HsqJ+A4CIAACIAACIHBRAqRUHjwl/85VzZvW3Lxy0ETlf3kjXA6ubIr5L3ophMeHhVsqudyZ44VvFglLm4WHz85Z2U0hrO7lQb6f98LovBenyPrCv3rnpc5Q8O/0KU/kX/jES1+apm4AnhIBAiAAAglKYM7z0wgQiB0BOi5o4VysXKA85qRMzV05Oe+5kXkrB+esGBWeHhK+I35+d4j+K01Z0SfweKKHfdKvy7qEx7tZ0BSKR1qEO6qERfUKx99fInzngj+eahee7eS+J9PzYL4PEexXWic5Vg7S+iFAAARAAARAAATCIvC9nnkUz3TPeaaLutUphO+0C4+7WCxrk4LkzePhJhZLGynmLKkX7qOoFe45w4K+kOC/Uix85F1xvN1Nx9jP5PiHz0rBZS9qXja91LhfMyTI4Wvu00+sNqCsWfCqBAIEYkWgU3gCAQIgAAKJTIAUrgpR55c82rLqzc62Hrd8TT3ML6veaLzkthJh0WkmeDI7xeU7RMdTfLOIBtyFcjzvw1d243OvsynU3H+mS3iqkwWddvka86oHAgRAAARAAARAIJiA3CLnbXT+X7povrRx1eb2qab67l/9a+ePV7S/tMyVsqRt1b2tz9ze+r07W5++laLliVsomh/9AouHb2xc8tn6uz5e/vAX+2srV71+gQbcMadflyN8erfo+E/9r5bjW5XteNnxstcVam9nKeXKiKpjQe5hwBcQiCIB+fDAFxCIEQHeF4oAgVgTkPveRcFTxzu12nt+/cP+/9k08L9b+n7/Wvev/63r9Re6fvZc56urOn/ybMd/PN3xH091/Nvy9tRHXS8sbXvuW60rvtG47Kbyuz954P4b27omJcd/4iCT+4deFqjLnjl+0em5dynb8czxrIHOm+nitXkWz3T5Jyob7sq2e4wOOSwWBEAABEwjEOszO5YPAuxqOo12p8vqZHcmeNnxna+uHPjLfw/u/n3ftv/s2fyj7l+ldr22rvNnz3W8spI03/njZzr+/cmOHyx3vfhQW8ri1u/d0bT8K5X3fXbXFy5nF+CpHf+5QiHY8exaPV2SZxfjxUb8U8zucvCBAHwsgL9zXrN/PorNNSwKBDQJmHaiR0ZJSwAGAoGYEpC8zu3uc/z9jcL9jeTpjh88Tnbvf/vXvW+92v3GS13rUzpf/n7H/32q/V+Xt7/4iGvdg23P3d/23H2s937FN1qe+Frjo1+sXHzd7i9/hDmeLsaT4/+xUNGOJ+3TXfM0GI/qEXRIU6OcrqyLl9iVjleO92ND/jTb8XASCIAACIAACIDA7AQebFPYvVlY0sLC5/j2Fx/q2fwfPW/+hAQ/fjqPzN2eurx93cNtzy1p/f7drU9/s+W7X2tZfjNNHz6U3rxs4YWHb6x64HPpX7uKOf7LlZLj6Xo866v/h8NM+7eQ4+tZpwGtFnf8kwPOGbdjA2u7k92FFUPOGY9jQzd958P6/YP7lePsYrhf+5yagwt7hlJjmKnvjgVlFr8Y6pqZ6crr9N/PYPIKIDsQAIFYE6BTMAIETCDA7R7oeBpn1/36C91v/Au14GXviYK/p/Xp20jwzY9+UZ7e/NDnLzx0Q9WSIMdL1+PJ8aT928Qb7KgRT0fO8g7m+DdGmMkce4XlzOvCrklaonNrGv1X6XjWoKf0PGI+4K5YuHy9cHkuk313Serl6//6IyyE6w+bqlvueMcO4bZaU/ON9UkNywcBEAABEDCHgFx70HJ828q76eo766J/ZWXHvz8l67z1mTtan1zU8viX/YJ/4DPNS69rfPBzVUuuS//qlVI7/p/KWV+9vx0vO55ylRzfw6U+48wV7rtAN+anFnjof0xsS5ny5z3ZowxWJzBJ87SGYoOeHG+y2uUdD8ebcwwgFxAAARCwNwFyrr8R7++rJ8d3/GhFB42ip88ffLf9hUdkqdPVd7/gl3yq+f5PNC+5tnHpPzkX/9Oer36MOf5LtYK24+myPzXEeSP+iZ7UfCb1mZkLaYsqhe8NOnrF/zHlN5Lj0+rkXDyON8TH3SynzvwZZ92E7weP4xdd7AF7y7oCEvsmpubx5Ut/zj+LiX8xSk1k/teV18tnD4pBn+Pf9/0kTqkbdfSIc9YNhspUWNYrpaFkPaOpfOEamSqSzUykqdZBTC+24xsC1k2xHGlzlnVpb6b2dmluLCaCAAiAAAjYlIDcmr+/3ddd30J2anny6zRsng2e/+GTdCXe9eLDbWsfUBqTvrc++JnWb3+yZfE/tiz5RNO3r62+79qMr3xUcjy120nzdIs8ux5PLfqba4W7W9nFJ/7MW/ERuGlnyYKsU9q5NVPYONE143ZW9zPl3+a85Ht981YMCotYP3kas2tL2jLSPHM8a17fvIfuu3d0i9MfEp+gS3GzIjFNfEfs+f9jmm8J/V2OXOFnojuPlbAO+a0XxAQN0ux8ITzEyoTYjj9KFw78U2b6HT86KvwwNy11vXBzmUamfMbe/tTr+cr0O354VHhdI1NRzJOOH4rJHHRRYI+UEV8BPgs5/nbF6imWk+ogUDPOnSE28z7Ftii3C9/DJ4BKEgiAAAjYgMCD3UJAsGY9c+fyr7Sve7Aj9bEOGkj/0mOuFx5iT8JZfY+s+bbHPtf28Kfbln6ibcnVbUs+3vzANTXfuibjS1cwx3+tTmrKU1/9gl8FOt4neOHpEdZwr8lNqxZl9mf3TG9r6tbWmZkhR+o+YfWIsHtKUafoZxO/M8YMSg396/OE5X2peZSApmfQd2503x+bKLbsO9LI5fdJvzq3bk09Qn0AYw4y9O2NwvIRaWmU4PHA4D8xx7OM2K9y4su3Cg/1CQ9Vss+gTKWKxVa6fu+b8eatqcdI50GZ7uQr3JpGy6Hl3+5Lz9fk9XGf4xvldROrBerlpJ3R2Ezh9kr1Fqk2EP8FARAAARCwPYFl1OXsC4XpSRvNj9zUtub+9n95pP2lRzv+ZRkNs3c9v0TVjm9f9un2h65xPXCla8mVLYuvrLn7yr1f+DBz/C2NzPGfrGHteOb4j1fS22lYO54ue3DH00tsVkySR7sO7xDeHiabOs5Qz3m+8O8usVm/XdjFnqPbdew4NXPFNitpe5vwCJuFOf7manpDTupxr1gh2MrqB5T4aJ4i8dbUPPqVFkU1A55yhNQuGjHwz7c0WqA/eGWCOT6fZmfT5eqFmDWLd0JlyjISFvuXpriO4MtazDT16Ij0/97JVJ6LHL+clBx/Z6s8UVxOaxpVMh7xr0/qe3ygYsBmKnMPWKwyC3wHARCwlgC9nRMBAuYQ8Jt+QHhwgKzR9O3r6d5319oHyO7tLz7seuFBWY3tKxfx79Ojgx2PXNOx9GPtSz7Set9Hztx+xb6F/4c5/rYmpvkb6pnjL/+N6Hj6P3N8lyR4cvxGj6SxxWL/9sy44+X1wgPssjc161PzprmVhfu6WJc+c/kfhOU+xy86Q++/S83njt8m6lxMfG+7L/E2Yfm4/7o469beJlzOU1J1QRotL42ZF5emDF7/YI6/4aTA37XHp5CbfYnF3IMyfYeNAHBupdz9CxRTamcq3LuN97p3Ha7kGUmv9tswJcG5t12e6FvOfkqpWJ/zwZupzF21afhvmATYyxYRIAACIGAPArwm4TM9Safx/mtbnlrUtvpe1/MPuNYt9Qv+udvbV36941n/uPrOpR/tWHxF6z0Lar/xt5mf/2vm+G92CLc0KxxPLXrm+C52VYDs/jR7Sa2wm7ez1wtLe9LO8RvVdggrPY4+plKxf5t+3SE87eZj8Vjj/km3T7RnSXKp+VQPIMdvFysEYoLlU/7E77DlUz8BFzm7/23ppLCBVSxmnAVUXWDfez2pKyZpUUEhZsQcf8r3U0DWvtyDMl3um5HyWsFWxrkrVKZu51k3W7i4Suxqxb1d/tWYbWIWrby47ZOsWrNjWGMztTdKc0sxEQRAAARAwI4EnpgU5OA1Fab5EQqyxoW7rm5+/Mutz97etvpbsuBdz93Vvvqb7d+/pePZL3U99Xl5eud9f+e684NnbvmbzOsvZY4nm3PNs/fOUTueO54G9VFHvSj4ec+MpRaQpUaZpb7jFjKmu97fIdxULLzoTWNPy7+QdmeL3Dx1nvBdnF7ukRx/29k5358Ul8AcLzw55U9c4But9pqoc//ftGPjJM0l7KJKBP+bdrxxSiCLr2TTlSGsVDhe/FWaQu14MWtxilamj9D0dvlBOl0FvcIN6+kSg0amYjeG9NfrohvxqcdCXgfeyRHwR9WRlcrlUM/EduHy7cIb2pup2iL8FwRAIN4ICCs8CBCIJQFecaFiJn7hvl8+ITw+TnI5f9tHmh68gW6TI82PHsumKa6Vd7hWftP1/UXtz97cseKmzieu61r+KZo+nvt2570farvtr858+ZK9n5nLHH9PP3P8zV3saXe+vvpm4X4a7N3HHT935eS856aEpaKlVnrmv+gVns4VHumfn+qd/4Np4V56Ck2OkNovfMnXBH9IHAm/tF9IOc++3H5+bso0hfDADvZiu2enhZR+4SZf4gdOszQPDDnyL9AX1oLnz7RxnqCUbK7luVLLXpyXL0oVUkY3nRZ8P6myZsvRyLRfnM5WUsriATZFM1PhWbaeUjJFRlJ6xa/KNPLKs+1aTnlNh9pMze3CRBAAgTghIKz0IkDAJAJyhVI0Pfmw4et/T931TY8sbPnuV1ufWtT69KLWp25pe+qrbU99xfXkTe3f/VzHY9d2PvJx6qinRnzHnX/TuuiSmi/Mzfj0HMnx1JQnx9NT6pnj/6GMNepFx/NGPHf8vLXuS1+cIsFf+tI0BRe8Mvj0eakzUrwwM88XFz1KU0+wZrDzT6w2IGyaEbvoc+XKwUVnT5QESbKZibI7sJ4gAAIgEFcEAuoQPtOTD2u/8qFzd1zZsPiz5x/65wvLvtD42Bcbly1sfHRh06M3NC+7rvXha1uXfrxt8Ufb7l3QdscHW2+d33jz3Ip/FnZ9UmCOXzzMmvLkeKmvPtDxXPPM8c9NXfo8a8SzIMEHOZ58P4vmZd+H+pJ6bMjf3X2WtemFOy9cdK6ES5Akm2nyfomroxQrAwIgAAKGCQRrvq3XW/Ktz56+ecHpWz9Wduc1ZfdcW3bPp8vu/lT5PZ+suPuayruurr7rY9W3X1Fz24LqRR+q+epfVX/pAxU3zsm7Tnj36x9XO57dO6dwPN3KJTfleWv+0pRJtelTpZZ9KMGHv6nUme8fc+fr4Q9/9kRJmSSbmSi7A+sJAiAAAnFCQH0tQGzKr/rv4b6a8uw7P/u/139w941/9+7CD//lpr//y40f3n3TgvSbFuxZ+LeZN35w3w1/nfX5yzKvuzTzs/OyPjNnz6eE3V//eJezbNWbgwHteJ/jacydeD2ebkgVP+kxdixYg35EMj3JXvQ9D+rJDw5OjfcBIEAgdgRMukiGK7IgAAIgEFMCUv+878YB8Xr8Jd8dW/VbRT+3aoh3iP+29XhWbRq85NtDrKOeX4+nvvoAx9OT8em9c/zdcf4H3g3NWzkoBfO9HFNzUtRBZ15pWDtuDwOB2BLAmGcQiDUBO96vFdujEsT0ECCdk+D5WHp+49xjYzSongV9oZvoHmT30bFP/kWOBweExf30qBzpV7r6zi/Aq0LteHb7XKOw6LRwR9mcO8vn3sVCuK+Wx5wl9TyEpY3sufn09hoe9L55+Tv/onxNHr6DAAiAQIISuJueGoIAgZgRIOHe36Jdxu6oZ297p6BH0PK49az0Xz6dgk+hT3o6PQW9dIY/pp6+0CcJXdvxd5Qxx4ual03Pfa8KnoCFnF4xo/9XORm+gED0CFApRYBATAlIZzZ+WkOAQAwIxLAA82fZ8nH187949oqUvsuWNfR01iJAAARAAARAAAQSnYBwy1nhmr8ICzbA8ajZgAAIgAAIgICtCMDxttqdiV7lxPqDAAiAAAhEkQAcD8eDAAiAAAiAgD0JwPH23K9RrAZiUSAAAiAAAglKAI6H40EABEAABEDAngTgeHvu1wStcmK1QQAEQAAEokgAjofjQQAEQAAEQMCeBPyO/yvcH48HA4AACIAACICAjQiwp+NdtYPdHw/HR7F7BIsCARAAARAAAcsJwPH27J+xvGBhBUAABEAABCwnAMfD8SAAAiAAAiBgTwJwvD33q+WVR6wACIAACICA5QTgeDg+Hgm4Yv9n+bGHFQABEACBWBOA4+PRcLHe6/G//Ngr3hX/ELCGIAACIBAhATgejo9HAnB8hAc2ZgcBEAABIuB3/GUL6/D+eJSJOCEAx8fJjsBqgAAIJDQBOD4eW7EJXaSisvIu1/sbBP634f3YCD8q64mFgAAIgEA8E7DU8TV/WLP6D3VReaJQFBfF1ydvPTfMpjxUAiwgQIbnbne+sypGlo/nwxLrBgIgAAJRIaDX8SfTVwvCLGLW5VpdiWevCkRxUSyjrE3CivQa/W7TXI0or5v+tYpKLcrchfgUL0p+1TvOGDTlo3L8YCEgAAIgEM8EdDqe6Wr9ptWh/afLZ7oSm+l4WjFhfb4Bq0VxiwzkbqNZ/I5nnfYx6a6P58MS6wYCIAACUSGgz/F1u1as2XUyf6NAn77sqckr/W3KE1v54t+ajev9/fA+89HsvrRiLUFlRPG/6RvlpQUm4ImlSgbvRZeyY93piumC3ARnquZ//uzE5Qf625+MT/dvUUCPRcilyV366s2X8pI3U7WEzlo/EN41whIY6j+wkd15uYLjo3J4YyEgAAJJTkCX48lhooHoWrXUXc+sFnDFWukzuUs/uHVLS9iYpeF4+fo3z0I5o+x4bkF2vVyxMgo7MnGyrEnVPpf75w2+vs6MzjeBzUhrxV2rvh4x69JkIIE6l8hIEzWXIK1h/kbxCxzvq6ygrz7JT0zYfBAAgagQ0ON4v/l8l6uDXTi74/0NWfGivlY7XhqC52+1+wblqaaoMlLVBsjuyrxYS1ucEjySIHhGTcfPvrTgrdaunfh6Mfj6SB0Ghi4K2K7hrirNGHMXlcMbCwEBEEhyAn7Hz19YO/v98YqedrE3nrrrdTle2UgNVrjKrFFxvMroETp+lqWF6XjtsYr80gBMHzCWEPfOJfmJCZsPAiAQFQLM8VeL74+/qOMDuuWl3mmtvnquK2Z0yVtS57lCscFT1D3k/t71EAsJ3Y73dbn7O+ElUpqOFxvT4fXVh7gqoaydyFsd3I5XZCSvzyZpWIPvIgj66n39EzEYR69eZFSOHywEBEAABOKZgA7HB3Z0K7rr/WPuWFOMRuTxVr7c7pfH3/Gf/CPyLtpXrxiVJi0kVItZdRWAq2L2SwNyd7c/WeD1e1V/+CxLU2yItPlaQw7V66MY3CeNYYTj4Xi7X4WJ57Mh1g0E7EdAh+Ptt/HYorglgHZ83O4arBgIgEACEYDjk+KRMglUIrGqIAACIAAC0SIAx8PxIAACIAACIGBPAnC8PfdrtOqAWA4IgAAIgEDiEoDj4XgQAAEQAAEQsCcBON6e+zVxa51YcxAAARAAgWgR0OH4V7cdRIAACIAACIBAVAgY01hne3XrhdKmhqLG+lOxi/qavOiGvKq05s0NxbQJtCHGCOiaS5/jZ/AHAiAAAiAAAhEToFqCLlfJicmOrqbyH731zrWPrRe+/oOEiyuWvLL69R0drZUUxgjomguOj7ioYgEgAAIgkMQE+nrbvN6p8AFQekps2PHUCCbBf2bJa6XtMwkatPI/fusvaMeHX2aQEgRAAARAwBoC3NmuPk/5BU9R7WR+5fjR8vH3SscPlYzmFo/lFI1mF47vPzmaUTBS75qklBeamyJ0PLXgDzvHEjpoE3q7zupqkRtLjHa8NUcFcgUBEAABexDgjifBN3VNn3VNO5s8FY3e8gZP6TlvUZ23sNZdUOPJq/IcLp06eGqYUpadaYjE8XQ9m/rnHVWjjqoxD/tzJ1Y4Ktma0yb0914wpm1dc8Hx9jjKsBUgAAIgYA0B7nhqwZPga1s8Fee93O6naj0F1Z6CKib4I+WewyVTjtMjlPK94rOROJ766kmQOeUjuRUjU1OTiRYTuRWjueWjtAkDfY26bG0scRw5vsuRKr9fPc0ZWFjZb+ppsSnOzjTfSqQ6umKTRcyWah6lmG0CFgwCIJBoBLjj853jvAVfcs5DdqcorHaT2g+VenlQO/7wadaOz8yrjtzxWSXD2aXDExNjiRXj46NZpWzNLXD8ZRd7fzwNkYh92XOmpTqM50KSi6wmEO4Cwk1nfFMSbE4ASbAdhtUFgagR4I4/Uj7B+ucbxP75GjfFkmdeI7U7SjwHS9z0ScEd/84h1oaLZMwdCTKzeIhibGw4KtGStVZuYa7LamTLbNm3bt2+Fr78kjfp19+WRCGv0VG22pmnh8xz/K31wlVvs/fHx63jfS3rQHv7W/1pqVzs/hY421kXaYUrEsvLVfQj0AJCVxZCZCTOnupwSB0BfH6tfGZm/Cufmpbmq5Zo9iAEb2aIAzNcSqGOa1XuYr6pqcpNYkTFqQ45rQRZEwhfc15j4wkiqb1F7XSEBYEACESZAHc8DbKjFnzJWakRT4LnQYLPETVPwR2/M7cqcsenFw6knxwcGyPNRxpM8OsyW6TlnPqtIKzLujDWkrmOT6Qvwtqslkhz4es5OjqYfnJg98mBuHe8smNdVmr4E0OWsZDteFULnaXjXen+b6I7w2nHB/Rpk3/89YEwFxAqI9FlAWvgdPquOijXWM5RJMZmUK4SfffpUHszQx+hYVEKnl0zdxEM9zOtoY9MwCb6r6BogVNOU+4ldf7hFxvNlFE+X2FxIAAC+ghwx9MQeuqfL6r1UsiC518OlEqadxSz6/E7sqPg+D8d692Z1zsyMhBxFG4RUvY1KpbTmLFuXUaj/Kn6NbIch4f7/3S87095fXHveH1lIPzUCscHakFtb0XbUbeiA5esVFHEjld3HyibuNJvmnkENoX93RCamxm245XdCLN1bGjm7qPEyfsdr2yOyyS1wfn2Ji0/nLpX+MUEKUEABOKGAHc83SMnd9FztR+rYt31suYPUFO+mLXjo+L4rYe6th3uHh7uizQa96xdu6cxYDkn3hQ2FbHpKWuZ4CPOQrHwoaHebYe6tx7qhuMDG+gz1Esc0hL+n+QWMGvwhZZaoJAMdAQw43HVBWakbq0q3RbQjg/aFkXbPdSRG04fRViUNNvxwR3poRyv6KkIaMdrAeGkw1nzuDlfYUVAAAT0EeCOzyoco1H0stTpe1615z2F5rNLprLFe+e2Z1fSZ4TX47dkdWzZ3zE42BtpNKSvXZveELCcgt8ImwppurBm795NgvrXiHIcGOh5K6uDIhkdr+6I5Y1Z7e7ZgIanUubyNfXZ240B8/uSBlyPv9jFY3VGqvWUlqluIGtO5hMDFxB0NX/2EQY6KWlaXh5ywiTuW6BoaDFv6R8yf6rmrQchyDMCiXeHgr5THFKDQFIT4I7PPDlG98jRrfCkefo8Xu0lxzucnn1lrDVPn5nFU/sLR6Pl+M2Z7ZszXYODPRFH/m/I5Q2K5XDrS+7vadi7RvhNfsS5SMsfGOjma56Mjk/qoyRhNl73jQ9oxCfMvsWKgoAhAtzx6cfH6E450vzxKmZ3imPVbnJ8TpVnf4Uno9S9p2gqszBq7fiNGa6Ne9pImZFHQ8YaIWV3g7So45sFISWjdqBhd4o0sTYjRZwSjbz6+ztpzX+d0QbHGyprmCnGBOTGejhNc12JY7ziWDwIgECsCHDH784bpbvjSPPHKt1HKjwU1FFPgj9Q4aZGfMZpd/qpycyCqDn+V+mtFAMDXVGJhozVckfm5kJxmQ3vpqS82yAtn4v/TOR59fd1sDWXHN9k7LE2uuYS5Hvn5sfF/fGxKoVYLgiAAAiAQCwIcMfvOjqcUzx5sNTNnnVTOnWodPJgmZvG2e0rce8tniTB7ykc31swRCmjMubuP9NbKbq723pYuBIiaG07O5r4mlM7frCvWZetjSUWFjUIV4v3x8PxsSj9WCYIgAAI2JsAd/y5lomcE4O5p4boofQ86DtdgKfYVziSeWJ4b/5QXcsYpdxztIY+DY+5azl/ml7Pyk2ZuEGbMDzoMqZtXXPB8fY++rB1IAACIBBbAuT44872MPPYk98W4btl25rKVv1iB72edcnLx9b8vC8Rg1Y+5Vd/HB3p1mVrY4nh+DBLJpKBAAiAAAhoECBn9w4O7zratCWz7pd/rl2/s+rlHc5Xtlf+ZHsVBX3n8fOdNVto/PrQeISO73Q5yXYv/24XvZ6VerwTLqgF//yGnSMjXeNjfca0rWsuOB4HLQiAAAiAgHEC5Gyvdyr8+SN0PL12nd7KOjzYPjbaOz7WPzE2MDEe/ZiaGotuKFZyaHJiaGJ8sL/3vC5bG0sMx4dfMpESBEAABEBATYA729XnoVfI0xtm8yvHj5azoCfYHyoZpaDH3O4/OZpRMFLvmqSU7e0tkVyPN6a6pJ0LjscRCwIgAAIgYJwAdzwJvqlrml4hz98wS8FeQ3dOepc83TdPg+1pIB6lPFFRD8ebVueA442XbMwJAiAAAiAQ8Lz6WvZW2RM1Xgr2qLsq9lQcR4WHXksjP68+wmfZmmZHe2Tkd3x8vFsWxwsIgAAIgEAiEVA+r56/loaeZctCfNode6ItPequzBOt59XbQ72mbYWwiN4fvyN+3h+fSCUb6woCIAACIKB6t2xhrftEtZeCHmpLr56jcJR7+Cvk+btl0Y43TfCUERyPIxQEQAAEQMA4ATjeTGfrzQuON16yMScIgAAIgAAcr9e7ZqaH43GEggAIgAAIGCcAx5vpbL15wfHGSzbmBAEQAAEQgOP1etfM9HA8jlAQAAEQAAHjBEx2fGd7deuF0qaGosb6U7GL+pq86Ia8qrTmzQ3FtAm0ISbIHo43XrIxJwiAAAiAgMmOJzu6msp/9NY7ifu8+tWv7+horaQw2fF1V6T0XbasIVSu9CpAlGYQAAEQAAEQUBIw2fHUCCbBL3v5j0fLGhJxR1Rf6KCV//FbfzGvHX+1dH88HJ+IBQbrDAIgAAJWEjDf8dSCf7+0fjpR/7zvl56jTaCX65jUjofjrTw+kDcIgAAIJDIBk59lS9ez6X2yXq+HQvxzJ1a43VNjI0O0CfT2PDg+kQs+1h0EQAAEkoCAyY6nvnoS5BT7m0zAmBgdGRro66JNGOhrhOOT4PjAJoIACIBAIhOwxPETE+MTE2PWR2vWCy9ktYa9JuPjo8ODfb1dLjg+kYs81h0EQAAEkoaAJY4fGxsRY1hHlLwpyH+/LdIx4yy5tOxbt25fS9irMTo6NDjQ3d3RDMcnzfGBDQUBEACBRCZgkeO53YfCjJastYLwZokvfclv/d/DXIJ2spbMdesyW8JejdHRwcGBru6OJjg+kYs81h0EQAAEkoaAJY4nWVKMjAyEFw371qXsa1QnbtyX4mvYi782Zqxbl7FvizRtSzFPX+ibILAplEb63T9LY7irMTA83N/f19HparTA8fNvwr1zSXNQYkNBAARAIEoELHH8yEg/xfBwX1jRuGetsKlolsRFm4Q3TwyzZMKbReIyacraPY3D5/at9U1hs594U14OJaYE/DPM1RjuGxrq7et1dbSdN9HxDQK/dw6Oj1KBx2JAAARAIIkIWOL4oSHyZd/gYG9Y0ZC+dm16Q3Bimi5foacEymT8u2pGZXo246bCUEsOsWIDAz093W2ulgY4PomOEGwqCIAACCQuAYsc30tt4sHBnvAi/zfCmr0NgYmZsH0TA4wuJgueIk9UZio5PszV6BkY6O7pbnW11MPxiVvgseYgAAIgkEQELHE8VzspM8xoyFgjCP9V6EtfuPm/Cht2p6TsbhCnsF/pu2LKgPS9NiNF2Fwo53J8s6D8b7cvWbir0d/f2d3V0tZ8Do5PoiMEmwoCIAACiUvAEseLau/SFQ0Zq/33zm0+TvMWkrHFv5TNG1NS3m1oeJd98sXK3+mLb7bNheJ0eSmqWcJYHxpw19XR1NpcJzq+yZRn4OB6fOIeW1hzEAABELCagCWO7+l2dXe3UdDlbfqeEEFr28kEf7axwUmOH+xrhuOtLrzIHwRAAARAYFYCJju+5fzpK5a88v7JouYLNY3nnU3nq+lLQgSt6oX6ynNnSg689x5twvCgC47HsQUCIAACIBDXBEx2fFtT2apf7LjvpTf/Z09WTXlBAkV1eX512fHMnAP3vrAp5Vd/HB3pNtXxly2sxfvj4/pIwsqBAAiAQPwRMNnxnS4nqfHl3+2i17NSj3fCBbXgn9+wc2Ska3yszxTH10v3x8Px8XfsYI1AAARAIN4JmOx4eu06vZV1eLB9bLR3fKx/YmxgYjz6MTU1Ft1QrOTQ5MTQxPhgf+95OD7eCzfWDwRAAASSnIDJjjfBi3bKQliEdnySH6DYfBAAARCIgAB3fFbhWEG1p7DGTVFQ42FR7ckTw1Hl2V/myS6Zyj41TCm3Z1fS56vbDtpJpXG7LXB8BEUbs4IACIBA0hOA4+NW8LRicHzSH6AAAAIgAAIREIDj4fgIig9mBQEQAAEQiGMCcDwcH8fFE6sGAiAAAiAQAQE4PjEcj3fLRlDIMSsIgAAIJCkBOB6OT9Kij80GARAAAdsTgOPheNsXcmwgCIAACCQpATgejk/Soo/NBgEQAAHbE4Dj4XjbF3JsIAiAAAgkKQHu+NzisVO1nqJab2Gt+0S1l+J4lfdYlZvCUe7JKfEcLHE7ikcoJZ6BY2adwH9/PMbcJekBis0GARAAgQgIwPFmOltvXnB8BEUbs4IACIBA0hOA4/V618z0cHzSH6AAAAIgAAIREIDjzXS23rzwLNsIijZmBQEQAIGkJwDH6/WumemFW+m9c28LCzYIeH980h+qAAACIAACugnA8WY6W29ecLzuAo0ZQAAEQAAEZAJwvF7vmpkejsehCgIgAAIgYJwAHG+ms/XmBccbL9mYEwRAAARAAI7X610z08PxOEJBAARAAASME+COzykaLaxx0wNw6PNEjZfieLU3r8pD4ajwHCh1HyhxHyweppR4Bg4cb7y0YU4QAAEQAAEzCcDxZjpbb15ox5t5LCAvEAABELAbATher3fNTK90fN0VKX2XLWsIlf2r2w7arWxie0AABEAABCIjAMeb6Wy9ecHxkZVuzA0CIAACyU1A5fi+kWlV4Hq8XjFHMT0cn9xHJ7YeBEAABCIjENyO37B3QhUYcxdFbetaFBwfWenG3CAAAiCQ3ATQjtclXZMTw/HJfXRi60EABEAgMgJox5usbV3ZwfGRlW7MDQIgAALJTQDteF3SNTkxHJ/cRye2HgRAAAQiI8Adn1U4VlDtYY/BqXEHX4/fX+bJLpnKPoVn4NTC8ZEVN8wNAiAAAiBgIgGV4zXG1Vd54HiT1S5nh3a8iYcCsgIBEAAB2xFAO94qf4eTLxxvuwMOGwQCIAACJhIIdnxBjYdFtSdPDAfa8Z1md9GjHW/iEYCsQAAEQMC+BOD4cNrTVqVBO96+Rx62DARAAARiTwCOt8rf4eQLx8f+CEAOIAACIGBfAnB8OK61Kg0cb98jD1sGAiAAArEnAMdb5e9w8oXjY38EIAcQAAEQsC8B7vjc4rFTtZ6iWm9hrftEtZfieJX3WJWbwlHuySnxHCxxO4pHKOX27Er6pBeZhqMopImQABxv3yMPWwYCIAACsScAx0eo4ZjODsfH/ghADiAAAiBgXwJwfEwlHeHC4Xj7HnnYMhAAARCIPQE4PkINx3R2OD72RwByAAEQAAH7EoDjYyrpCBcOx9v3yMOWgQAIgEDsCcDxEWo4prPD8bE/ApADCIAACNiXABwfU0lHuHA43r5HHrYMBEAABGJPAI6PUMMxnR2Oj/0RgBxAAARAwL4E4PiYSjrChcPx9j3ysGUgAAIgEHsC3PE5RaOFNW56AA59nqjxUhyv9uZVeSgcFZ4Dpe4DJe6DxcOUEs/AiVDbumaH42N/BCAHEAABELAvAThel3RNTgzH2/fIw5aBAAiAQOwJwPEma1tXdnB87I8A5AACIAAC9iUAx+uSrsmJ4Xj7HnnYMhAAARCIPQE43mRt68oOjo/9EYAcQAAEQMC+BOB4XdI1OTEcb98jD1sGAiAAArEnAMebrG1d2cHxsT8CkAMIgAAI2JcAHK9LuiYnhuPte+Rhy0AABEAg9gTgeJO1rSs7OD72RwByAAEQAAH7EuCOzyocK6j2sMfg1LgLajwsqj15YjiqPPvLPNklU9mn8AycWl2GjjwxHG/fIw9bBgIgAAKxJwDHR27i2C0Bjo/9EYAcQAAEQMC+BCxx/Jnqk8WFh0+ddCRiVFfmx07qqiXD8fY98rBlIAACIBB7AuY7ngRfW1PU1Xl+dKQr4aKvt5lWnjbBHM3D8bE/ApADCIAACNiXgPmOpxZ8ggqe10ho5WkT4Hj7HhPYMhAAARCwCwHzHU/98wnXfFetMG0CHG+XIwDbAQIgAAL2JQDHG6hwwPH2PSCwZSAAAiBgIwJw/GhN+k/Fv301XaNtR7amHXFdbKAAHG+jIwCbAgIgAAL2JWCl40mo3K6yYi8mVx1t7vBsPTpSuu+nvyto89k9vLngePseENgyEAABELARAe743OKxU7WeolpvYa37RLWX4niV91iVm8JR7skp8RwscTuKRyjl9uxK+nx120HDF6T91+OVQhV9z1rS0dJ8eLZmDfefpp+RMw1vLhMd3yBc9bawYINw2cK6K1L6LlvWEIo77RIbFUtsCgiAAAiAQBQIxIvjybLcryrxS1PS96Xx7vT6AukLTy9Nl3ra/fUDKRlN31pQL4qc/yl0zhJTI17xp8zdP4vYyg+secDxUSh5WAQIgAAIgECsCcSR45lx089oOp53p7ML574v3Mf8vyRg9lOgv/3LYSLnPQSugt/9NLM0QNhysoAahrgm3OtaLXs4PtbFEssHARAAARCIAoHEcDwfB6ftY97I9l1WD+51V18RCFEVUDo+cKBAUOu/C46PQsnDIkAABEAABGJNII4cP1tfvemOn3V0PRwf62KJ5YMACIAACESBQNw43tejrhgEx7rWVdfIlQ16ZQOd+upVVvYvx1hf/WwDAOH4KJQ8LAIEQAAEQCDWBCx2vH/Em39oG1O7+Lc1Mz1gFF5wX71/dtVgOtaBfyZTXMhsY+5C9/8ru+uD2vRwfKyLJZYPAiAAAiAQBQJWOj7C2+TCu88tajfjKdYWjo9CycMiQAAEQAAEYk2AOz6naLSwxk03x9PniRovxfFqb16Vh8JR4TlQ6j5Q4j5YPEwpo3J/PL29LRbqNWeZtPLmOX5RvXA17o+P9UGA5YMACICATQmY73h6/3qiv1vWtFfIC3C8TY87bBYIgAAImEHAfMfTg9ro/ev0elZqDSdimCZ4AgXHm3EMIA8QAAEQsCsBSxxv+Dm4yTYjHG/X4w7bBQIgAAJmEIDj47neAMebcQwgDxAAARCwKwE4Ho63a9nGdoEACIBAshOA4+H4ZD8GsP0gAAIgYFcCcHxiOH4+3i1r10MQ2wUCIAACMSMAx8PxMStcWDAIgAAIgIClBLjjswrHCqo97DE4Ne6CGg+Lak+eGI4qz/4yT3bJVPap6DwDJ56dGm/r5h9zh3a8pYcJMgcBEACBhCRg/rNs482j8bw+cHxCHlRYaRAAARCIEwLc8edaJnJODOaeGjp4algO+i/F/sLRzBPDe/OH6lrGKOWB/DP0+eq2g/GsRtusGxwfJ4cJVgMEQAAEEpIAOf732fVhrvquvFZeJ4DjzalGwPFhlkwkAwEQAAEQ0CBAzu4dHN6SUbd+Z9XL250/2V4VHK+8Xf3azuotext6hsbheHPsznOB43HQggAIgAAIGCdAzvZ6p8KfH46H48MvLUgJAiAAAiBgJQHubFefp/yCp6h2Mr9y/Gj5+Hul44dKRnOLx+ids9mF4/tPjmYUjNS7JinlheYm9NWbpnm04608NpA3CIAACCQ6Ae54EnxT1/RZ17SzyVPR6C1v8JSe8xbVeemN8nQfHb1F/nDpFI3Fo5RlZxrgeBMd3yBctUNYsEHAvXOJfqRh/UEABEDAfALc8dSCJ8HXtngqznu53U/VslvkC6qY4I+Uew6XTDlOj1DK94rPwvFwvPkFFTmCAAiAAAjoJsAdn+8c5y34knMesjtFYbWb1H6o1MuD2vGHT7N2fGZeNRwPx+suZ5gBBEAABEDAfALc8UfKJ1j/fIPYPy8+7Y6C1O4o8RwscdMnBXf8O4eccDwcb35BRY4gAAIgAAK6CXDH0yA7asGXnPUseeY13o4nwZPdKWgK/8IdvzO3Co6H43WXM8wAAiAAAiBgPgHls2xJ5zyOVbkpDpQywfNgrflidj1+RzYcz+5cNyeERRhzZ/4xgRxBAARAwC4EAt47V+OXOjleFjzJ/gA15YtZOx6ON8fuvmfgwPF2OdKwHSAAAiBgPgHle+fYQPpq1l2vDCb4UjfeO2em2uW80I43/4hAjiAAAiBgHwLc8Zknx+geOemtsjV+ze8rc/PILJ6il9NQyu3Zlbgeb5rvmeOvxv3x9jncsCUgAAIgYCoB7vj042N0pxxp/niVl782npryDqcnh14eX+HJKHXvKZrKLMT74026DB/QjofjTT0gkBkIgAAI2IgAd/zuvFG6O440f6zSfaTCQ/FelZsEf6CCNeIzTrvTT01mFsDxcLyNij42BQRAAARsT4A7ftfR4ZziyYOlbvasm9KpQ6WTB8vYOLt9Je69xZMk+D2F43sLhiglxtyZ1lEvvncOffW2PwSxgSAAAiAQMwLc8edaJnJODOaeGqKH0vOg73QBnmJf4UjmieG9+UN1LWOUcs/RGlyPN03zcHzMCj4WDAIgAAJJQIAcf9zZHuaG7slvw7tlTRM82vFhFkskAwEQAAEQ0CZAzu4dHN51tGlLZt0v/1y7fmfVyzucr2yv/Mn2Kgr6zuPnO2u27G3oGRqH4+F4HEsgAAIgAAIJQMCArvhWvbrtoIF5MYteArr76qkKhgABEAABEAABIqBXOZQejjcAzfAswq31+u6P93qndNUt9abXtXAkBgEQAAEQiJzA77Prqb9d7+kajjesXtNm1O14KkyuPk/5BU9R7WR+5fjR8nF63dChklGK3OKxnKLR7MLx/SdHMwpG6l2TvOTx9PRTVuEYpbEkKPfkCeJsfliyW3mRMz/Mx8tzBGQTyFsC2fwyzHPkhYqGxNOJektGnd7T+4XmJgOuQjveADTDsxhxPAm7qWv6rGva2eSpaPSydwaf89JbBdlrg2vd9CxDetQR3R9J907wfcnT07uE6TnG/J2D5of8PuNk+MIfGW1ymL9PeY6W7FCT2crZAbIJ5C2BbEkxls/JdM8bnahprJx8ug7z9F52psGAe+B4A9AMz2LE8dSCpxJQ2+KpOO8lu5Pa6aigxxayw6+KCZ4edXS4ZMpxmr1GkP54etI/FamiWq8lwXJPnqhhqE0OS3YrZWrNbjUdL9+bgGxCqbYEsjXF2HdOphvZ6UT98nanfLpWnt7p3M5rA8Gn9/eKzxpwDxxvAJrhWYw4Pt85zlvw1HbndV75FUOHSr082KOOTkvteOrSp/TSwWmVaC06KZtwSoqXLOy+Z/tGWF9U8Kep/O0O2VSYoc4JlkC28ARV6+Z9rnSfG32qTu/yuZ1absGn98y8agPugeMNQDM8ixHHHymfYP3zDawFT8ekUvD0vOKDJW76pJAdT9fsqUJwosZL3fgnqr3WRA1bgSQJ+dVPZn6xZrdScTJrt5LdN+ydCP4E5BjtAjPBKvOypiSbVYxVO4ufk5WOV53elWf44NP7O4ecBtwDxxuAZngWI46nQXbUgi85G9CCJ7XzyBE1TwHHx+jcd9HFWnJytObMCMebU2m2wkCWFGPL2iFWEJbbXUrHK0/vvJuWmu9yQ051et+ZW2XAPXC8AWiGZzHieBqHSTuerlrJO/5YlZviQKkUvBw4iqXr8VRoqN1/vNpLV3TotYPWRLWXViBJwoRxScFZWLNbqTiZtVtDtuNNHN5oe8jKvWlJMbbsHGVWMVYdL3x7lY6XT+98XAI/t1OoNM9P7/R2GQPugeMNQDM8i3ArvZPmbWHBBmH+wrorUvouWxZynCQ9lojvG7rjQr5sJu94eo2g7Hj2hZryxdL1eLqtjobm0Vg8eqOwXGJM/sJyT54QX95scpi8Q+XsTNutoRxvJmfbQw7Ym6aXYb4rLYFsWjFWZyRuLx9zx6/H0910qtoVfxM8D36Szy6ZyhYv4W/PrjTgHjjeADTDsxhxfObJMSoock+avPsdTg+9J5hHZvEUvW6I70s43uwD2IqToyVnRsrUNLZwvGmopYysKMZwvOr0Tu1++QwffHqH4w2r17QZjTg+/fgYjbGk45A6eXjN19+NU+XZX+HJKHXvKZrKLJTa8dT5Q6PzHBUeR5XHUW5RUO7JE8TZ/EiCPUtj7qgUsc+qgE/zaCcBZP9xan4Z5jlaAtmqs5O4vbw9xtvxqtO7sgmXE3R6h+NNU7XhjIw4fnfeKA2wJM0fq3QfqfBQUEc9FQUqAQcqWCM+47Q7/dRkZoHkeHrsHVUIqIdnf5mHLtVbEgHXEXzjBuw6kTibH5bsVsrUkp1oPl6eIyCbQN4SyJYUY/mcTC93J7u/8nY1fQaf3uncfqjKq3l6h+MNq9e0GY04ftfR4ZziyYOlbnYTfOnUodLJg2Xu3LIpuga/r8S9t3iSBL+ncHxvAbvGQ3/0XFtKRr/SVRx5+L3JXyj35Al2tcz0MHmHytlZslvNx8tzBGQTyFsC2ZJiLJ+T9+azc/VrO5njdZ3eMebONFUbzsiI4+nhxvTsQxqmQaMxedB3CurwodhXOEK1Qio0dS1j3PH04HqWrHiYhmnQaExLgnJPniDO5oclu5UytWS3mo+X5wjIJpC3BLIlxVg+J/NzNb3cnT51nd73HK0x4B6MuTMAzfAsuh1/3NnO91A4f3vy28JJhjQgAAIgAAIWEtiV19ozNK739I73zhlWr2kz+h1/WXj3ztH7B3cdbdqSWffLP9fSOwxe3uF8ZXslDdbgQf/l8fOdNVQrpEJDhaC9veVERT1duUGAAAiAAAjEG4ED+WfoRE1h4PRuuF5CN2Ob5rlkzog5/qod7P74MB1veI9iRhAAARAAARBAX72ZdQ59jqeaFwIEQAAEQAAEIidgpuqSNi8djk9aRthwEAABEAABEEhEAnB8bSLuNqwzCIAACIAAEYi8OyHCJcT5XoDj4XgQAAEQAIFEJSC/SMWSgQ7xP3IQjk/Ukh3nlUesHgiAAAiYQACOnx0yHA/HgwAIgAAIJCqBKDre1ecpP0+vTZ/Mrxw/Ws7icOmk4/QIvXKF3rZKkV04Ts9521swXN82mSh3B/gdP39h7ezvljWhRoYsQAAEQAAEQCB8AlF0PAm+qWv6rGva2eSpuOCloCml9V56p1rhGTcFvW01r4oe4s6e3Jowjl9UL78/Ho6PtCZ75YM/DSfCL75IaQMCEY7oSZLZbbCjsQmWEIii46kFT4I/08LsTmrndj9V6ymo9uRXsThW6Xm/wsMb93B8pL60pLhEmCkJvr7+DI/z5+saG881N59va2vu6Gjr6ens7+8ZHOynNBHmgtkTi0AUz0GWjCoyIdP4H7iUWEUuqdY2isfXkfIJueF+6oyHgtru9Nq9w2VeetWqMg6fRju+MzLH1/xhzeo/1EW4ED67rkXpShy0erLjQwl+eHgQjjdyAopsv4SVYyRZiPOGyiWK5yATdGtJFnB8WEU0KudD2y0kiscXXXenVju13VnzXXQ8CZ6H/PLf3BIPvZmQXlyEdrxOx+etF+S/jVn6xKxZauVTtq5zN08capaLLYo7fhbBj46OxLvjaRt9O2LNrpPap56LcfDPZZSkOt/g5YS/DmGe1CJZIByvqBrQwKWKRi8buFQ1/n75BMV7pePqgUsnR+mV0/RGykQ5USaegyMpz5qHjO8UvSlP57k9zAPQaLIoOp5G1RXWuClO1rjpursseJXm6Z289Mq+RCm6Qjxcj6/btUIQ1uf79nH+xvX5kRfQSBwfqrRdbK3I37MLfnx8LL4dn7VJWJFew4/hrE1U2Zq9/mT0sNR9xrSH47scqf6aLH1LdTiVU1IdXeJ5IyCZb2LQL9IPoRNb0iKnTEnw/oFLjV76b3mDp/ScOHCp1k0hDlyii5pTiTFwKbq1XgsPmYiyVp4Z9Dhe85x5sROprvODluOdaf7jxpkmHXRpTumQCJ4i/aB0vCz4o5V+2UuteThe1x7q6TyZvlr2iq/0KA0t7SEpjVgh4H/iFDFl+kb6r7+WIC5TSrRm43pfAjZFqoT6j9vArAPb8f682IUD/zJDbSD5W/MaPHXRUwueBD85ORH3jldi9F3sCNgFCrZyQ59xW79JZL4pT0rAUCt4ivvItwv807Xm6qzV3MuKazea+5etuXpGXlnxlRhplQJLlLQ3QxU5VlRkJrQo8buq/ITZjicfByhb1Lk8hdlaPA1pTuTqDzxzsf+FSGyV4ClfPnCptsVTcd5LJ0pudz5wqaCKdX6S4I+UM8cnwsCleK31XlTYUfWoWOCDzgwXXQe9l0rDWWBQGpXjpUqv70ghn3O3y4dX8BT5YFG146kpf6zKTY7PKXPLffXsCxyvz/GapUcqoL5TqmZZob4j3qsvm1u5+wNP2ZLaaRZm69CLVTpesWKsayGM8kr+Dh5kpxS82z0V346vzecm9rfgtVhptqp5lYt16Pm+yFc9lPuI7wKZs+Zcyv0o72XV+AzN/Rs8o1gzU/QuXmzXa5UNYuIvP4xM0EKi4vgZ38knoCogn5HoS2AFgSfTTmyh4meoc5413BuY4Hnw/s9Dpf4pfPhSIgxcUuxruXSpWwh6ar0a1VBWB5Wui7ElK1od/gZMYOVYOdJotuq1VIGWDskQddOgBpKyCsu97q8li+dPRUtMu7klt6ZC1MXDacKFHuCi8otGO95/UMiHj1x1Dp7iP1hs7viLvltWn7nDr5HN0pnjP5Z4UVI1oQS/LYKzUxYjuVz61eJr2cmLVR82vCoQ2D1wsaox+Vs1il4leK/XE+eOl/Yyv/bmq0IpYIWo6wTTVtWWgneBctyD5uxyrpojJDT3b8BZTKt4aJYo1a5XFg1e5Hg9o5MqQL6uI1Wa8B2vnFFlaFniSm1rTvR3OaY5NRNbqfgZaeBSLV2S90ud2kPK4Us5fOBSItyAFOVar0Y1lDuVSlpQj2aoyrG6xIaoXvuqC6xzS7Nto91AYuc9XqllM/LqvsapT6umKze3pNaUYkZlXqGacIHNqjCNE67jpTq0wvFyrdp3vNjX8eG9Pz5M4vqTaV3pURpC1TqX67mh0igPAFXpnH0WOXFAgVaYPgzHK2+TCxb89PR0YjheqryHGBgRzCG6jle2ZmYpCbzeoFyZi844yx6crWzQyZdOwVmbgnNUFLaLj6vX7KuXrR/Qae+bqpyo6ufnZyjl9Xh1AmtUn1U4xrrlfaEauPReldTtmV0ylZ04DxIRO6iiUesNroaKRYhfY1KPclWVbVVlV1ViVceg+rgQj2Wtuqn69qXgGTUdP/vSQp0QLlKfDmpWhdFWjKLjc4vH2bh6sXpKX/KcAR31fKJUPU2wcfUWO56Xb80xd/4apfqiKT8qZh8DL7f7VY1IsYGuPTpUedjU/GGTdL3ZV79WVDM1T+jM37774DUFTyfduHY8baDcS++vawexCuYQdcf7dlnIvSyvQ/B5UD5p+kZRBPbVz7rrQ5QNWo1NNLBDKg/axdKg47mY5auFyuvxyonM6LP21QcktsbuPNf042N0uZ0uurOoZiFrPqfKQ7G/wpNR4s4ontpXmDA3IEmjUOmUollN1FXrVbVSuMbEOkTMHR/qgpeqHaU8YQafRVWNKGXXvfpMG9iO1+zM07C4ZPowm4vhOl6qYYfbV3/cqb4YT4PtaWJiXo+32vFyNVaqZSrvnVPWFsUiInWd0fEgDqYLeZ+bL6WULLhxr+wKVhVThd54KvnY47nPMuaOP+gmlODj3fGKcYVa1/DE3m+RFefgPyVF1/Hh7WVpHXgx8O1BdfEIbDYFjrnzb05Ab2RQkZN+VY45UqURNz8ix1PJYKN9g8bcyRPDGXOnSGyh5N89NpJTPHmwlB75OSUHu8O4xL1PjMziqfRTk3sKx/cWDMX7DUgxqvUGVEP5BW+xo0h5MT5UH6SvHKqrv6Hb8b4u99maTIrSG35ffWB1WbO2PVtdXGN9lM2qaDje3x1vYMydasAdv6EOjtdzW0UY/TBh7uY4SUZt9NkFH/eOT+rdF6NS5G9naN47p2ici7+LN9QFTxRvq1MuQLoTKLD/X1oCvwfPor9zLRM5JwZzTw3RrXFy0H/pZR48qPmeeWKYBF/XMhbvjo96rTe4/qrsOmKtecXwdS1ryneOqBs5wY4PbsZo1U01HjXmT+ZbmVC9F6EGzSjSa9TFlasasJL+wX0hH84RZA3tcfXiYsVjJNJ752hQvdwRhXZ8shsinIfVx3VffQS1roArfYr/xEicCbTYKD6jwyJrxzxbPOcugcpzvK1qFI8vfj2eX5I/WeO/xsQdzyfienyyaz7eDgCsj+UEongOirlsLcognh0fXHm1vERhBZQEonh8KcfV8+vxyptBcD0edgcBENAgEMVzkEUKjnm28ex4CDXOCUTx+FLdO8evx8sPq0/46/Hzb6rD++PjvDRj9UAABEAABGLUjqdbQuixDXRXCKn9aIX4NMYqd06lJ6vCnVnKfE8TacTonlOTmQWJ87z6W+uFq94WFmwQ4HgcOSAAAiAAAolFIIrteLolhC7JO9j9IJM86DvdD0LPciC18ykk+L0JcUuIb3CVAMcnVoHG2oIACIAACMgEouj44FtC5PtB6GYQfpNI5slEuSVEum4Ix+MSMgiAAAiAQKISiKLjDQw8if+hJHB8opZsVORBAARAAATg+NnLABwPx4MACIAACCQqAXK8tRHn1Sw4PlFLdpwXLKweCIAACICA5QTgeDgeBEAABEAABOxJwO94y94fH8HzUy2vImEFQAAEQAAEQCBuCQiL6oWr4+C9c3ELCCsGAiAAAiAAAglKAI63Z/9MghZHrDYIgAAIgEAUCcDxcDwIgAAIgAAI2JMAHG/P/RrFaiAWBQIgAAIgkKAE4Hg4HgRAAARAAATsSQCOt+d+TdAqJ1YbBEAABEAgigTgeDgeBEAABEAABOxJAI63536NYjUQiwIBEAABEEhQAszxV+H+eDyHBwRAAARAAARsRwCORzseBEAABEAABOxJAI63535N0G4lrDYIgAAIgEAUCcDxcDwIgAAIgAAI2JMAHG/P/RrFaiAWBQIgAAIgkKAE4Hg4HgRAAARAAATsSQCOt+d+TdAqJ1YbBEAABEAgigT8jhc+WkavkP/wQ21XpPRdtqxh/re79IZw7yACBEAABEAABEAgLgjQzfGfPyLdHy9csYe9SZ7F274v/L8xDcpLb8R0fXwLp4cGmBAG2BpYK92E3zay7QZyMbL5tG46w0AuRrZFbzHWuRV6t1pOb2DzDeRlDjED22JkFv270kguBs5jcbtiBrZF/yxGiqX+XEwqyQZ2pYFZaPP/hxn2Y2nCgg2C8Pf/j/2DAAEQAAEQAAEQsBeB/w8eNHi162DOKQAAAABJRU5ErkJggg==
!usage
{{{[img[TraceLog Msgbox.png]]}}}
[img[TraceLog Msgbox.png]]
!notes
//none//
!type
image/png
!file
./TraceLog Msgbox.png
!url
!data
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMsAAABuCAIAAAAGSHA5AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAG3tJREFUeF7tnQlcFEf2xwvxvrLG6MY10TXeZwTvA8X7AkUUlaiIJniA6GaSvbI5/omfJJvLv8Zkd7NmdzXZTSIRFWMMGjerBGO8iQIiCzLMfcAcnIJo7XtdPT09w4DAzOgwdn9+n7G6uvp11avvvKruLpwASikRbQFhlwICAiGD3mqD2YEB/MHWbTHdJpC0DCQ1t+EzIDCQ3qak5g5p0YK0IOSOzUoN7PjUhs3xiS2g2ieqwSpBxW6B9G2HulWxPahwa1JdQ1pzvVvdgrRuiXmkBnWLY6MV8NOSK9yS3KKkSkdPDncwBYSxLSAsA9R6Q1kb2e2uL9BfvIbq+zod+B4NepcGfUAn7kSFfIia+uc6xQr4juqp6j0+5Ds+cdmJkMn6V/hkPV5byIOjgBMQYNN6cw2ZeoUE/SBwRQS8WqzWA14tNlvbPH8HigqQ9XmLgoCzoTvsAuCYxJlSuhl5ADqUidWZpRkoLKywfhcEmeJdFoAEMWBAbbbeBpEVpWTSFYYWEkamnSMRCrIkNyDOCCIbipmAtsAt5YFbq4E58tztQBkFsTR8CpkswTJbP3sHQiArKcnJAwGb7/iOoG5QGdatrPuYAuKrW8RVBW4sC4yzBsSWkzUl5Cnuc2UJ7PI5sSbCtKoIP+FolIGsMKIgB7RUSWZcJSF5IsIWXCRPFdgVoyXr9Iw24IwJaatDeBTqJCjOCvWT1Mw88HRRIGitMWCtAQY0EHlKS1ZoUFFqXoAO05JCVIQcFBCeR+aDcsicayhIAF7jzpNHv+Rm+cGn8DAQtiSXF0ONg0zgjA9sm0qIIFuog0PIophrBrKvSE9WSXLlAQDISRxMrZYp1+/Sq4tuCXOpBibWvy1vFXqRhFxAvIArULc9HGGgaedgml8XYWz0FA+gjCrMgVC31kBi9CjoSFZjBr4kX/aAEI1YfGK7MFmKkK/fqa0uzDO+85z+D7HaZ6M08eHq9XNVa6ernp6pWjMFpFw1CaRYNgq1ZKQ8fFDerN4ZS0abc66sf7MApvlI1JBvyID9HGH9PnNFmEocwwTCBKpEYGmxpPBVcAqqQnS9jwnBlfc9wUYWX5Mw6nF4wZAHEavovd+YP91h+ewD019fN773a8ObWwyvbtS/sl7/4jrd79fofh+j+3W0VrZMsyVCvXGeKnaqPCo4Y3bfowtGqg1VPGFPHEO0Or9EYLBEwkIutJgljmFIGAYnFqK4ORlqrcGeKQ5a4rh13zvSZyvga2zhLAru8GA6BWwhXgJh+lfiLPv+bN3/V9Pf3ira+YLxHZnh9UT9qxt1L8cBZPo/rNX9drXu+WjN1kh1fJjq6RmF0eOuzB+UNKobTrwghg37kdQmDOdoMBXDSRgXwGKQLUFsAsjmgPZh0eXIeB/DlctL+w5wPkUYTxVjy0bYAjlZIAdKdM+vALbMe98r/vAV49vPGrbF6196Rve7GO1z0dqtSzWJi9UbF6g3zsdxM3aqctVE+bLRV8KG7B/7KBIGkzAg7Jc/imIYQAdPyeAWACiG/oCABDMqbmolJkx8l4E3Gi5jmK/hJdWnLg8sVovYUpBwJcpGmHZrZNHO3xftehHwqryQBtxoZdHaxCXqjeGqZ2ar1kxTrpyojB4P+aXfJiuiggqWjLy6cFjyxMeRsLFXeMJgHoaj5C9OIHSTgLA8DJhQoae0x4spLS6TceEKJEuvobklQBjT7utg5+Zu2w2t7Ptb9LpZdFtryhTfexSVyPhGQv6t42/Y7nuj1Jydyt14VH+8CAZ/VrKeYuxcB/uZn9sN2m+qfRMs6FQfFGPLkTCY3Rvf3GJ8+1cQvYTO5PCao1oTCngplo0W8hWRwwsiR1wNr0UYPw8DwgC6UO6RBgQw6JtoHUJDzcd/+x8Si48hELiiTFnIZcCLxJYgQNmppFsygUi2uhiPUuXu8RdtkHEEZKa2f3Qb6ZaKaWOhDR1IZ8oW8kxwhBXs7vYlT5jxomzoCR4g18XU5PNKbNj1G6TbNrAvO26mcNbc5gOZ76AvsO6KMHXcbJh14eD4cpzutzECTKq1M1SrQ5QrxtrxWjhQETFEvnjY1fAhyRMe42PY4AwcJe0xTCAMrsoRRt6qMFBqOH6YRJvI0xxSCFwaedpEkqqQn4+3kUkZgauLyNtYkstJxhPhXjKaJ4yMOQ/WeIwEdKBoVhYLNvUR5roYZ7koV9ZtGzOOCv2IoHEJsiZ5AHrcHsDsoyQQpnshVgd3jvD5/ErtlqUCUjDrsuMV3k+x4AlFeH95xODMsMEHJvREwsbkENeEwXQP+dBxzyfNGJkyU8lcJfkSkYINgVtl2p0LSd1u6OOFRUCY7PsajG/Q81B4vg5Pj7awGEbGXIKXCTaMDpAoK5dfgGX/4XSoGEdJjGH/qa/Y5zd5uLGYQZIHPCBEsgVa20CpxCFp9WS4VcQbxt+shhmYZusSdcJCASyWUC0eqFrUVxn2S2X4E4WL+mfN739wXA+eMIhZABk8EsN5GESz8TlktgqnCOztEveySZZejUNYaKbs9G1apMs0ctCE6ZE8HCJTSKyVxFYgNNe+lx0vwyD3wmU8PZqLeVB4/GU+jeUP2PP36NDyfDafg1ESDnEDMRJ2sp5isjSgmQuf87lXYA2UxGI9HlhsJA7CkIaERY/TJi7WyZbr4Obx2eWaLZH43HXDHAEy9fJh6iUD1BFPqMN7qcN7Kxb2yZ7X5+CY7kjYxOt8GINRsus7joTZ8MJ3me9Ww/CX+fEp6HvDycOyE8BQwe6XjJj5j20kNDMQCEsCCrkufwHzMchFmkh0mcNM/7oC5kxk/BU+H8m7svsanHbJRthBEm21EZZWTzGOsJLjMiDMRFaYuNNxy/wCdyU12gNRVhgxeIk4A5cqlgarNy3Q/mqp9tllul9Fwa2lZnO4UwzTRg3QRvbRLHxME/6YMuyx7NmPHRr1MBI2SY6E9c3GGIaE9b4C78AxhsFUhhG2Bt+ik9ibXK+beaReKzfQksxM4MyEQ+TyssC1FdyIqcfdiCpuRn9RNlNFnuICG5DET/MvysZnwZt5ez7s/rGKzd64GHaYPFVmIyy9vmJf4JuyzI8/JkvxVT9qTwGPeJgth+X7pmBNi2/KzpmFLLaASwsXDYVnXZqEhcCWdusSzZbFAl7auBCWvlNu1S3to4voqQ1/VDX/0WvTux8OeggJCy1EyEbkIWHd3ucIg30kzMDwQsKeqYIlHLLTOCrBgIsMRVdz94wwRJ4m3b4m8VVkQ41DrMJjcDdwhsRytAFhIddIUgkkDSeuEETWng8Ey9K4u0Ik7CsSW8kTNsLh9FrFbBxH4DIS/Bok2cZNWw7LFwsXn0iq3wOMextn0CvyBf2VMSHqDXM1mxdqEiPseG2cro2brFtnv5fUR/TQhXVXzemaM/VnKcPbI2HTdGSSQkQYRDMkzIDjMcMLeogjjCTfRtMYjY6SxBrZGVt3zszDpYwH71BaBWMWPDXABxOyi9xAeYRE37IRlgtU7c7hyPs/A4l1yCex1Ti7R8K+xjSbh404W2+xKpJUilXKygfLqCSsIQ7TEdyupIZ7YFUVEcT4Q8jKQNgrs3opVoxVrZuu3jBPwEuzcZZ2wzTtM5N068YYYoYL+fr5XTQzO12b1CFlaGskDFhikOHaCohhjDC4lYAhksMLhj9uDVo1ScAohf3HkPrgjoHFs9W3ydY7x03wVLZABi/P192BZWsk/hZPyXx2z5hKQnOBVBLHgQUnrrYRxuXjoe0w8nKExYkIY+VtpzsW4856/YZthEW7hrR05HspHvJxkdgaXxL7QkKVuASjLfomWYFjy43QRwsXj4AHEwBZ+amvIUcTN0MTN03zTIh23XhdbLB+1RBDdD/Ir0zdq5/bWR3a7trYVocGtkDC5piRsPEGfLJvGyUVZAHcmuFiRSCM4RWYcAtEEvNwnr6GX7xKEi7A7IrIbsNaViIzkzHwXOoi2YKrJXHBZLyZBG8jwRdIPD4RJdNvtIi/A+J34UTHfDy0jjOIZYRzbeVtp4uL8QbxLD52Il4LzSzfx0XibvuoBPQ5zoCS/MmPwEBZuDRIuXKCKiZEtSZEFTNJHTNBHTNOszpYu3KYbnl//dLeMERCANPN7KAKaZU9qsXBAQE8YRDGgDB4G4mE/eIyBjSOMHEAA7xaw/rprQgTWxvNVk4LYvn2hcJbaKBNPt7TUvUEDzgQb+MMKMkZ1/m/Mx7LDxt0I/LJgqhR8uWj5VFB8mVBhctGKKKGqJb0V0X0Vof1UM/tqp7RSTWljXx8i5+eJEl9uUX5YaUYxoAwfpR0JIxBhjFsYzWMjGxhP+JVizC2Kr8uyATa7ntC4ql+D9SGTF18++K8QRfGd70wpeflmX0uz+l/ec6Ay7P7Zczp+9PsPldm9cqa1TNrevfs0K5ZIZ2zJ7TLGtPyp5EBaUPIl5N7OxOGTytEhLHV/mwexsbK1vFVzpxxQ6Sg2jFM6tFm5AHnUZsLY+v/XGrKzvh65qDPhnbaP7LLl0EP7wt+ZN/Ih/cHd00O7nog6GcpIzsdHtH+yPC2KUNapwwKPDIw4EA/sn9yb0Pm5fW7rA4xzEYYzPS5eRg8RuI+4WkqCoMZ/H0HxxnT5homNktzEvMsi3++Ix+d+vjInIwfGW234dw8rNXKivV/wsdMjdrURTXrd1hbLSrBIZLNw2CUdCAM3oDC2gp+aTn/7gjm/vY/mBH/NdHGarh/dBL0JX+T2PB75ntR0nfu4HzpeQrABHix+0f2qGJ5BdxIoiABjy0W45ML/GQJQYstJMwMD2b5ozDrYhMvJzkThg8s5PhXIjMuB8zMgBXVuKga1iRygrXbTLhEEUAUVkXaF+Da1kmKl4JIaScPzIbnjj4jXGyodF2fGXm4mgsEL3uYpuTyuywfxHLgE95CguDVNnsdCQn4BJxcEzbjMhLGQSZwxmhzEiuAEsqLTrQfFYrdvwS0yEfE+4o5ygfkRbewt0bsXrLN6Nzu8aa2UflF+hxJkgc85QEyKZf02Ue6visRJn2vvOIBiTCvuNVTAcAP7NgJayeNktL0wAsewPuDx/fgKCkR5gcBwwebYCesbdB1aabvgz3U3KskESbNw7zrAYkw7/q3uUcg9+tvJ6xNUI6bo6Qq643rqZ1AkHC/ZpIF//AAEtaLm+m7SZhBffba0Y6Vlj9WWt6CBOz6h4OkVrjpAY8RlvdDhPFaOK36iFb9w5izBHbdrJl0un94wDOE6QtP5HzTrqbkNVr6Fi3bWVP2fs437SHTP3wktcIdD3iGsNz0RfrMmbTkZWp+kVq20bL/12eFQaY7NZPO9Q8P2Alr29SZvjp3b86xLjXFMlr8HDXKaNFvqPnVGvPrOccehkP+4SapFU32AJkCz/T34ky/yYRlHhtVfH0eNW2m5nhq2UQt8CmjlleKc6PgUJNrJp3oHx6wE9a0e0nV9b1ZRzvT4jhqWfv9Nyue2xoGSk9dSa1bqeXFrKNdoIB/eEpqRdM8QELySS8uhjWNsIyjA8z/nUENK6hlRcL6aRO5bfOG6dQaS4sTzXmRUKBpNZPO8g8PuEVYwU9v5JzoQY1RVLeYmiNHiTZqjqKGNdS0JedELyjmH86SWtEED9gJa8I87PyBHta8UKoLo+r5tHjBmNEjhnEbJGhxGNVEUuNa641IKNaEmkmn+IcHxO8lG/fW6L/nf5eV2o3q51D1DKqcQY0zI8KG9OM2SMAuVc6m2khavC7rWE8o7B/+klrRWA808c23XnX2hy863lRMoeqpVDmFFoZQ49TEuMG9uA0SsEsLp1DVbKqLuqleDoXhlMZWzovls/++acPfrzd2wV3ts5xymma2sdXwavm0bexnR3ekOa4JaGrTxM/DGrE+LDs9Pvc/PalmElWOp4XjaME4apjwzqsDf85tkIBdzCycQNWzqWF57sn+cIpbxEDLBSagtSQ2OduNZRFN85f/E3ZkR12Oddl2si2d4Y49Yks7fgGaQhhEo1OfdqiUj6LKUbRwFC0IpjeCqXbUvt0Du3AbJGAXM+GQYgLVzKtULoRT3Axj6dv5LxYkNiWdcYtXiTCXgbBuUJAhp6gvzqnbn6K3RsENjWGXjkUUnO5N1SOpYgQtGE5vcFKMOJs6qCO3QQIPsfyCJ6lqMtWHF5wZBid6AAuxFzDNNu4LVG+bryfF8mXBU1zJ5O18Bj8i3NWaYN9ektgjK1+BbTs2MLO2KGsv7Bh30RpfeEfamWTurHpqwtXW1ky+4rUDOQQhe6PsTWaVsbfapR37uWhCPGLYPOYwr2goYfA8jK3eaRhh6oITJz9peQsAUgyhBYPpjcE0n5N8sO7qoM6d2oIgAbt8PhSQP0nVobfUC05+0gpOdwcyjF4bYm1TBPQIS6Mrtx+pjzARl+nbt6Vzvc7b4cffBljjfWov6fzNFg3fWCXsJCgsGkrEYUAojFMfjoB6amKfGNVtUI+YOs+fWKwCy8w/9dsRf4U8TlgDn1acP7ooP60nVQI3A2n+AJonkm5Qvz5tQVQ3yCE/H0LaaKqdlZ8+GE53h7A6GWIA1fetYl9QV53NznI616U1lyWdoHGYLPIo28KKqALiiOvUr3eticicvUVOIdw+PbKVdtFGsSHHQaC2J12Mg0d22NsuTjvMjxv35vtG5t5Tn7a5VTiQyvvRG31pfl+aJ5Ku/8QxbUFU198hH4pBtFNOuKWadeqf7cFI0yGri6G7E8aabeOsfg/WZa1phNV101o7YDSc9bpmUS5jpADfXce1RsUwcKbHCTu5b5TqXG+qGEALauEFqOn6Ry7oCHImDA7l96eFT1LNdNWFIDDiGcI4XJxHSVuUsg1Stu9T9t938DcHMJTEJqeJ5q21xj77mOtkzV6SnwDVvoowHeaNiCrp3Oq6CHPZLnFf1n6UwAPnOEqKeOLr6RCHRGO9wKu4Sq7b3uj790bM9POv7v333jZUDXMsVwGMI2zjmodArgiDMDYQH23o5/17b3sw1UTInGI1N7Gwz/TZhIzbNm3f5njvY5/G4n2oy2/zXa0JZ9keGjlfxW7BcaYsDEcuh1SXqInbVWerHe8z+KcG9pk+TFsdvHFXO05Qij1Ze5S8a0TkwG0EYd9+MkB76ZdU0d91AAPCgDwYH0GQEI+eLJ3fjxYOp5pQbcZYMNVEwrz6sFEy7gUPNHQelvXjG+n7HqLaoVQ5kBbCKOlKxkFUkMsCcPupnkCN89OTuoFBCbIHwQO4Poyt3qn/XvLIX3sYcwZRw3CqHUbVQ6mqlizDD3/a5/GeHUCQoJbhLsqoh1HdGFo825g7FQw+CP6V2tggwjJO/S4tqQstHUtNwbQoiBpcqWJU3z5dOnMbJGjFKNfFikZT83RavjQt6edgVuoAv/eAmDDXz/S1irPJ73csK55AKybQ0vHUOo5aXKlmwuCBP3+E2yBBaya4LmYdT0tDaeWiMtNiMAvG/d7FD3gD707Y2WPx51J7UTqD3p5Kq6fSqimuRaed+Wb0yBG9QJCgdFqdJaun0dvwC3Ix51IHgvEHvAP8vvl3JyxpR4cyK/xi5XxK4beTQHPrFpQRVE8xMLIICCuzxoBxv3fxA97AuxP2xXvtTbDMkMIPPC+hNNJDiqJ0rUm/Cow/4B3g982/O2Ff79v8+bvtP3ubeFxgFoz7vYsf8AbenbDr2We+O3HgxLH9HheYBeMPeAf4ffPvTpjfu0BqoFc9IBHW6Fe5Xu0P/zMuESYR5l0PSIR517/+F5Ma2yKJMIkw73pAIsy7/m3sN97/ykuESYR51wNkSr7w/4c19K/Z/O97JrXIex6QCPPuN9h7PddcLEuESYR51wPcKmp+jas0SnrX180l6ni2nnbC2vjFL2fptVmqgkuF+efkeWe9qrzsNI9LqDDUX5F/HhoCzfFsf997a/5GGPSKpjDjhQ+/6L98G5n8fDNV9/CXN7y5R6e6Arr3THj2iv5GGHz1Aa+B4a9f0tJmLWjCHz7cJ8Uwn5u4AGEQvU5kVviBoCHFhlzPRpR7bw3/H1f2G7n+MQ+DGQyMjMevlh+/WlGD2y03FRjYEiw09tPNix6/gvWHhpiLC+49E569or8RBjEMOuabjLLUn8qqq6uap26m/lSemlEODbGY5J7t73tvjfu/qP0ohjHCjlws/fpS6c2bFe6rTZt2jTLS2PK1jVdWlh+5hPWXCPO5SRh8QRlhKedLQBUVpc1R5eVY+ZQLJRJhvktY8o+W5DPWigqAzF21a9cJjCiPJAj/fU7ikQI0q0xJTExRMvsXd8HRP13ENCvvjsrLrclnLPvPWPyEMPx/K/xulNx32vzFDxboKo9I8VUCSTyk4K39+CEhiV/llysOJbJMSJCErxSeuRZUuKzMAvUHSYT5bgz716nif6YVQ1e5rw4dxn1A4g/LRabkBxMTD8qFT8ejHTo85OZFS0vN//re9K80k78QZv/lLH94L8nmYXu+KwJBV3lA8oMJCQflDqbO7CI7z2F+fALi5YmriOyXlJj2fle897siiTDfjWEff2v42wljaanJfXXsvTgh4YDcwdQPu8iOc/IDiNfhHcTxaMeOXdy8aElJ8d++NX78rdHfCGvrF2++WQz7S6rhL6l66CpP6PQusimlQGSqIDkhIbmAfZYUF6RsIrtOe+JC/CWs1qKPuPr7D2Hsmb4/EfbBEd0HX+ms1mL31bnzw/mHNpGE5Hze2un3CUk4lGvNR8K4zNxDCVwOVwDKu3lRi6XowyM6kL8R1rRfML33z4jrvyKLYTtTtDtTNBAMPCWEzLa9/yNnlieMXSKdw+66Ry5nsRhZ/f2EMGEFoj8Rtv2gZvsBNXSV+3rooUcaZaSx5WsbN5v1UP/3Dqolwnx3pv9OsgpksRiao8wmHdafJ6zQ10aJxtbH31ZRs1HyrWQVyGhUF6E07qjrIz3g9MZ+NvmKUGe9rpDVHxpiNSka26O+Vr4pv/7na20Q10d54wIsEGU91NwFDSm1anzZ2w2pWyN+saEh5u57GXXh5fVv7IEFouEvndr0mqn5CpoQ/84n5WXG++5SNyuAf/P9OPe3Rg389T83r+ft0/WaTLjES39Jau7r9De/+8+yMkNlhcnbHvO2fX8jDJYdw7rQUqu2ory4ssJ8s8Jys9Irqq6u8LhEVS2pullys9JqLr7hbQK8bd9OmH88cfW2vyT7jfWAv830G9t+qby3PSAR5otP9bzd6/fSPhLmT+8l76XvpGs1xAMSYVIM864H7ISRHpdhsv9wpLp7vKltVH6bRQaxyFyrJMkDjfYADJHDv+NHSdL9AK7YR+21JdiuS0EZseopuQcvUI+c7DuVFF+lnkO16wxP+cRyboVT/R13nc6t35Tz0Xot1+lPwfMN9qqD/xvSZXX0kTuOcq5DbSo+RU567sYnruSRj/AfSZIHvOOB/wHtITVTythkHwAAAABJRU5ErkJggg==
~TraceLog some information
//{{{
TraceLog("WARNING", "You should be more careful !!")
//}}}
Next message will be displayed to the user if the current minimal trace level is at least "WARNING".
[img[TraceLog Msgbox.png]]
The //~TripleState// property specifies how a check box will display Null values.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Control]] | ~CheckBox | ~CheckBox |A control on an open form or ~GridControl. |
!!!Syntax
//control//{{{.TripleState}}}
//control//{{{.TripleState}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
The ~TripleState property uses the following settings:
|True |The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null. |
|False (Default) |The control will cycle through states for Yes and No values. Null values display as if they were No values. |
!!!Error messages
|Property '~TripleState' not applicable in this context |
|Value '...' is invalid for property '~TripleState' |
!!!Example
<<tiddler "Triplestate example">>
Identify if a checkbox accept Null values
//{{{
Dim ofForm As Object,ocControl As Object
Set ofForm = Forms("myform")
Set ocControl = ofForm.Controls("myChkBox")
MsgBox ocControl.TripleState
//}}}
(Q) In code behind my form, I'm trying to reference the value stored in a control on my form in a SQL statement. But I'm not successful in doing this. I'm using the following syntax:
--{{{sSQL = "SELECT * FROM Employees WHERE [LastName] = myControl.Value"}}}--
What am I doing wrong??
(R) In order to reference values contained in form controls, you have to use the & operator and concatenate the results. The positioning of quotes is also important.
!!!Solution
*In an SQL statement query-, table- and fieldnames are surrounded with a special character which is __depending on the used Relational ~DataBase Management System__. When used in character strings whose SQL nature is recognizable (in [[form filtering|Filter]], in a [[RunSQL]] action, a [[RecordSource]] or [[ControlSource]] property, ...), //~Access2Base// will substitute the square brackets ([]) with the correct character.<br />In next examples the resulting SQL statement is assumed to be used for such a purpose, reason why it still contains square brackets.
*When the WHERE clause refers to a numeric field, it is sufficient to concatenate the SQL sentence and the value, like in:
//{{{
sSQL = "SELECT * FROM Employees WHERE [Age] >= " & myNumericControl.Value
//}}}
*A bit more complicated is the reference to a date field. Simplest is to use the ISO representation of a date '''~YYYY-MM-DD''' (between single quotes):
//{{{
Dim sDate As String
Const cstQuote = "'" ' Single quote
sDate = Format(myDateControl.Value), "YYYY-MM-DD")
sSQL = "SELECT * FROM Employees WHERE [BirthDate] = " & cstQuote & sDate & cstQuote
//}}}
*Similarly if the database field is of Date/Time type, the time should be added in the SQL statement. However the "time" control in the form is separated from the "date" one.
//{{{
Dim sDateTime As String
Const cstQuote = "'" ' Single quote
sDateTime = Format(myDateControl.Value + myTimeControl, "YYYY-MM-DD HH:MM:SS")
sSQL = "SELECT * FROM Employees WHERE [BirthDateTime] = " & cstQuote & sDateTime & cstQuote
//}}}
*Finally for simple strings, it seems easy. Just surround them with single quotes. However, if the string itself is able contain a single quote, it is safer to anticipate its doubling:
//{{{
Dim sName As String
Const cstQuote = "'" ' Single quote
sName = Join(Split(myCharControl.Value, cstQuote), cstQuote & cstQuote) ' Replace ' by ''
sSQL = "SELECT * FROM Employees WHERE [LastName] = " & cstQuote & sName & cstQuote
//}}}
{{firstletter{
@@color:#930;T@@
}}}he reader is assumed to have already a reasonable knowledge of //AOO/~LibO Basic// and of the //AOO/~LibO Basic// IDE. The knowledge of the //~OpenOffice/~LibreOffice API// is not required. A basic knowledge of the //~MSAccess// object model is an advantage.
!DEFINITIONS
*[[What are objects ?|Object Model]] - A necessary preamble if you don't know
*[[What are collections ?|Collection]]
**Their [[Count]] property
!FORMS and CONTROLS
!!Introduction
*The [[AllForms]] collection - all forms
*The [[Forms]] collection - all active forms
*The [[Form]] object - one active form
*The [[Controls]] collection - all controls of an active form
*The [[Control]] object - one control on an active form
!!Properties
*Form properties
**[[Name]]
**[[AllowAdditions]], [[AllowDeletions]], [[AllowEdits]] - is a form updatable ?
**[[RecordSource]], [[Filter]], [[FilterOn]] - which data are queried ?
**[[IsLoaded]] - is the form active ?
**[[Height]], [[Width]], [[Visible]] - how is the form formatted ?
**[[Bookmark]] - how to identify the current record and go back to it afterwards ?
**[[OpenArgs]]
*Control properties
**[[Name]]
**[[ControlType]], [[SubType]] - control typology ?
**[[BackColor]], [[BorderColor]], [[BorderStyle]], [[ControlTipText]]<br />[[FontBold]], [[FontItalic]], [[FontName]], [[FontSize]], [[FontUnderline]], [[FontWeight]], [[ForeColor]]<br />[[Format]], [[TextAlign]], [[Visible]], [[TripleState]]<br />[[Cancel]], [[Caption]], [[Default]]<br /> - how is the control's look & feel ?
**[[Enabled]], [[Locked]], [[Required]] - is the control read-only ... ?
**[[DefaultValue]], [[Tag]], [[Text]], [[Value]] - what is the content of the control ?
**[[TabIndex]], [[TabStop]] - what is the tab sequence of the control ?
**[[ControlSource]] - which data is linked to the control ?
**[[Parent]] - which object contains the control ?
!!Methods
*[[Move]] - move and resize a form
*[[Refresh]], [[Requery]] - requery the underlying data of a form or a control
*[[setFocus]] - set the cursor somewhere
*[[AddItem]], [[RemoveItem]] - manage content of a [[ListBox]]
!!Special controls
!!!Subforms
*What is a [[subform|SubForm]] ?
*The [[form|Form (subform)]] property of a control
*Subform properties
**[[Name]]
**[[AllowAdditions]], [[AllowDeletions]], [[AllowEdits]] - is a subform updatable ?
**[[RecordSource]], [[Filter]], [[FilterOn]] - which data are queried ?
**[[LinkChildFields]], [[LinkMasterFields]] - how is the subform related to its parent form ?
**[[Parent]] - which (other sub)form contains the subform ?
!!!Gridcontrols
*Tabular display of data via a [[gridcontrol|GridControl]]
*Use of the [[Controls]] collection to find the columns of a gridcontrol
!!!List- and Comboboxes
*What is a [[ListBox]] ? What is a [[ComboBox]] ?
*List- and combobox properties
**[[ItemData]], [[RowSource]], [[RowSourceType]] - which data in the box and where does it come from ?
**[[ListCount]], [[ListIndex]] - how long is the list and which item is currently selected ?
**[[MultiSelect]], [[Selected]] - how to manage multi-select listboxes ?
*Listbox methods
**[[AddItem]], [[RemoveItem]] - manage its content
!!!~OptionGroup and ~RadioButton controls
*How are [[OptionGroups|OptionGroup]] and [[RadioButtons|RadioButton]] related ?
*The [[OptionGroup|OptionGroup (Method)]] method of a (sub)form
*The [[OptionValue]] property of a ~RadioButton
!INTROSPECTION
Specific methods are available to manage property //indirection// and property //introspection//.
*[[hasProperty]] determines if an object has a given property
*[[getProperty]] and [[setProperty]] help managing the value of properties
See also the [[Property]] object and the [[Properties]] collection.
!SHORTCUTS
A [[shortcut|ShortCut Notation]] is a character string designating unambiguously forms and controls. Next functions help managing them:
*[[getObject]] returns the corresponding object
*[[getValue]] and [[setValue]] get and set their properties
!ACTIONS
*[[OpenForm]], [[OpenTable]], [[OpenQuery]], [[OpenReport]], [[Close]] - how to open or close //~OpenOffice/~LibreOffice// objects ?
*[[RunSQL]] - how to run SQL statements ?
*[[FindRecord]], [[FindNext]] - how to search in gridcontrols ?
*[[GoToRecord]] - how to move form records back-and forward ?
*[[GoToControl]] - how to move the focus to a control simply by its name ?
*[[SelectObject]] - how to browse thru open windows ?
*[[Maximize]], [[Minimize]], [[MoveSize]] - how to move and resize windows ?
*[[RunCommand]] - how to run //AOO/~LibO// menu commands ?
*[[Quit]] - quit the application
!DATABASE FUNCTIONS
*Search a single value with [[DLookup]]
*Make totals or similar computations with [[DSum]], [[DAvg]], [[DCount]], [[DMin and DMax|DMin, DMax]]
*Make statistical functions with [[DStDev, DStDevP]], [[DVar and DVarP|DVar, DVarP]] functions
!ERROR HANDLING
*The [[Introduction about error handling|Error Handler]] - to read first
*The [[TraceError]] function may be used by one's own Basic code
*[[TraceLog]] is for user messages or internal debugging information
*The logged information can be displayed by mean of [[TraceConsole]].
!EVENTS HANDLING
*The [[Introduction about event handling|Events Handler]] - to read first
*The [[Events]] collection of ...
*... the [[Event]] objects with their specific properties
The //Value// property specifies what is the current value of a [[Control]] or an [[OptionGroup]].
!!!Applies to ...
| !Object | !Type of control |!Remarks |
|Not all controls are valid in [[GridControls|GridControl]] ! |>|>|
|[[Control]] |~CheckBox<br />~CommandButton |Meaning:<br />0 = Not selected<br />1 = Selected<br />2 = Don't know<br />A checkbox also accepts boolean values {{{True/False}}}. |
|~|[[ComboBox]]<br />[[ListBox]] |The {{{Value}}} property is {{{Null}}} for a multiselect ~ListBox control.<br />Otherwise the {{{Value}}} property always refers to the content of the __bound column__ (if it exists). |
|~|~CurrencyField<br />~FormattedField<br />~NumericField<br />~ScrollBar<br />~SpinButton |Determines the numeric value associated with the control.<br />A ~FormattedField most of the time contains a numeric value. However it also accepts, {{{Date}}}, {{{Boolean}}} or {{{String}}} values if they are compatible with the set format. |
|~|~DateField<br />~TimeField |The expected {{{Value}}} is of type {{{Date}}} for ~DateFields.<br />For ~TimeFields it is a numeric value of the form {{{HHMMSSmm}}} (the highest possible value is 23595999). |
|~|~FileControl<br />~HiddenControl<br />~PatternField<br />~TextField |The {{{string}}} contained in the control. |
|[[OptionGroup]]|Integer |Specifies the currently selected [[RadioButton]]. The buttons are counted as 0, 1, ... from left to right and from top to bottom. |
!!!Syntax
//control//{{{.Value}}}
//control//{{{.Value}}} = //value//
//optiongroup//{{{.Value}}}
//optiongroup//{{{.Value}}} = //value//
!!!Returned values / Arguments
{{{Variant}}} (see the remarks in the table above)
!!!Remarks
The //Value// property returns always a single value. For multiselect [[ListBox]] controls the //Value// property returns a {{{Null}}}.
The //Value// for a [[ListBox]] is the value of the ''bound field'', i.e. the value linked to a field of the underlying record in the database.
If the control or the optiongroup is bound to a database field, changing the value in the control programmatically modifies also the value in the database accordingly.
!!!Error messages
|Property 'Value' not applicable in this context |
|Value '...' is invalid for property 'value' |
!!!See also
[[getValue]]
[[setValue]]
[[OptionGroup]]
!!!Example
<<tiddler "Value example">>
Set new value in text field depending on value in combo box
//{{{
Dim ofForm As Object, ocCombo As Object, ocText As Object
Dim vDesc As Variant
Set ofForm = Forms("myForm")
Set ocCombo = ofForm.Controls("myComboBox")
vDesc = DLookup("DENOMINATION", "CATEGORIES", "[CODE CATEGORY]='" & ocCombo.Value & "'")
If Not IsNull(vDesc) Then
Set ocText = ofForm.Controls("myTextBox")
ocText.Value = vDesc
End If
//}}}
<!--{{{-->
<div class='toolbar' macro='toolbar [[ToolbarCommands::ViewToolbar]]'></div>
<div class='title' macro='view title'></div>
<div class='subtitle'><span macro='view modifier link'></span>, <span macro='view modified date'></span> (<span macro='message views.wikified.createdPrompt'></span> <span macro='view created date'></span>)</div>
<div class='tagging' macro='tagging'></div>
<div class='tagged' macro='tags'></div>
<div class='viewer' macro='view text wikified'></div>
<div class='tagClear'></div>
<div style='float:center;' macro='tiddler BookMarkTiddler'></div>
<!--}}}-->
The //Visible// property specifies or determines if a //form// or a //control// in a form or subform is hidden or visible.
!!!Applies to ...
| !Object | !Type when<br />in a form | !Type when<br />in a ~GridControl |!Description |
|[[Form]] |||An open form |
|[[Control]] |All except<br />--~HiddenControl<br />[[SubForm]]-- | None |A control on an open form |
!!!Syntax
//form//{{{.Visible}}}
//form//{{{.Visible}}} = //value//
//control//{{{.Visible}}}
//control//{{{.Visible}}} = //value//
!!!Returned values / Arguments
{{{Boolean}}}
!!!Remarks
A [[subform|SubForm]] cannot be made hidden programmatically. Neither exists a tabbed interface for forms.
To simulate anyhow such a tabbed interface, one can store in the form several groups of controls by mean of subforms. To make visible one subform while hiding the other ones, have a look at the second example below.
!!!Error messages
|Form '...' is currently not open|
|Property 'Visible' not applicable in this context|
|Value '...' is invalid for property 'Visible' |
!!!Examples
<<tiddler "Visible example">>
Hide a control on a form
//{{{
Dim ocControl As Object
Set ocControl = Controls("myForm", "myControl")
ocControl.Visible = False
//}}}
Hide a subform although a subform cannot be made hidden by hiding each of its controls
//{{{
Dim ofSubform As Object, ocControl As Object, i As Integer
ofSubform = getValue("Forms!myForm!mySubForm.Form")
For i = 0 To ofSubForm.Controls().Count - 1
Set ocControl = ofSubForm.Controls(i)
If ocControl.hasProperty("Visible") Then ocControl.Visible = False
Next i
//}}}
!!Observation:
{{firstletter{
@@color:#930;O@@
}}}penOffice/~LibreOffice Calc, Writer, Impress softwares have proved to be valid alternatives to their //~MSOffice// equivalents. Base has obviously not reached the same success. Try to find on the web examples to download of //~OpenOffice/~LibreOffice Base// databases, code snippets, how to use ... ?
If you compare
*The number of objects, constants, services, interfaces, methods, properties, enumerations in the whole ~OpenOffice/~LibreOffice API - including indeed also Calc, Writer, etc. - is about 20,000.
* The number of collections, objects, methods, properties, constants in the whole //~MSAccess// API - indeed only //~MSAccess// oriented - is about 1,600 including 800 constants.
you will admit that both softwares are functionally extremely rich but also that //~OpenOffice/~LibreOffice requires from an application developer undoubtedly a huge initial effort !//
AND ... can anyone tell me: __why should an application developer know and use the same API as the developer of the software itself ?__
Additionally
*Calc and Writer applications, in most cases, do not require any script programming
*Base, at the opposite, does require such __automation__ capacity __for most business or personal applications__. As a minimum to validate the entered data and avoid database corruption.
!!Conclusion => the 80/20 rule
>''Why not implement the few % of the //~MSAccess// API in //~OpenOffice/~LibreOffice// that cover 80% of the needs ?''
The //Width// property specifies the width of a form
!!!Applies to ...
| !Object |!Description |
|[[Form]] |An open form |
!!!Syntax
//form//{{{.Width}}}
//form//{{{.Width = }}}//value//
!!!Returned values / Arguments
{{{Integer}}} or {{{Long}}}
!!!Remarks
!!!Error messages
|Form '...' is currently not open|
|Value '...' is invalid for property 'Width' |
!!!See also
[[Height]]
[[Maximize]]
[[Minimize]]
[[Move]]
!!!Example
<<tiddler "Height & Width example">>
(Q) How can I enlarge a picture by moving the mouse above it ?
(R) Bind 2 different image controls with different sizes to the same database field.
Considering next table:
<<tiddler "ProductsTable">>
and a form having a small (for thumbnail display) and a large image control, both bound to the same //Picture// database field ...
!!!Solution based on mouse movements
... use the (small) control's //Mouse inside// and //Mouse outside// events to let appear and disappear the large image.
Link to them next code:
//{{{
Sub ZoomInOut(poEvent As Object)
Dim ofForm As Object, ocZoom As Object
Set ofForm = Events(poEvent).Source.Parent
Set ocZoom = ofForm.Controls("imgZoom")
ocZoom.Visible = Not ocZoom.Visible
End Sub
//}}}
__Caution__:
The [[Visible]] property cannot make visible a control which was defined with {{{Visible = No}}} at its creation. The //imgZoom// control must have been defined visible.
To ensure the right behaviour, we reset the //Visible// property //After// each //record change//:
//{{{
Sub ZoomInit(poEvent As Object)
Dim ofForm As Object, ocZoom As Object
Set ofForm = Events(poEvent).Source
Set ocZoom = ofForm.Controls("imgZoom")
ocZoom.Visible = False
End Sub
//}}}
!!!See also
[[Visible]]
[[Events Handler]]
The //getObject// function returns an [[object|Object Model]] designated by its [[shortcut notation|ShortCut Notation]].
!!!Syntax
{{{getObject(}}}//shortcut//{{{)}}}
| !Shortcut |!Returned value |
| String |An object of types [[Form]] or [[Control]]. Other types are currently not supported. |
!!!See also
[[ShortCut Notation]]
[[getValue]]
[[setValue]]
!!!Example
//{{{
getObject("Forms!myForm!mySubForm.Form!myGridControl!mySubControl")
//}}}
is equivalent to
//{{{
Forms("myForm").Controls("mySubForm").Form.Controls("myGridControl").Controls("mySubControl")
//}}}
The //getProperty// method returns the current value of any property of any [[object|Object Model]].
!!!Applies to ...
| !Object | !Description |
|[[Collection]] |An array of objects accessible via their index or their names |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice// database form |
|[[Control]] |The representation of a control within a Form or Subform.<br />The control may be any control type including a [[gridcontrol|GridControl]]. |
|[[SubForm]] |Identifies a specific control which is a subform of a database form or another subform |
|[[OptionGroup]] |Identifies a group of radio buttons within a form or a subform. |
|[[Property]] |A name-value pair allowing objects introspection |
|[[Event|Events]] |A description of an occurred form or control event |
!!!Syntax
//collection//.{{{getProperty}}}(//property-name//{{{)}}}
//form//.{{{getProperty(}}}//property-name//{{{)}}}
//control//.{{{getProperty(}}}//property-name//{{{)}}}
//control//.{{{getProperty(}}}//property-name//{{{, }}}//index//{{{)}}}
//subform//.{{{getProperty(}}}//property-name//{{{)}}}
//subform//.{{{getProperty(}}}//property-name//{{{, }}}//index//{{{)}}}
//optiongroup//.{{{getProperty(}}}//property-name//{{{)}}}
//property//.{{{getProperty(}}}//property-name//{{{)}}}
//event//.{{{getProperty(}}}//property-name//{{{)}}}
| !Applied to | !Type | !Argument #1 | !Type | !Argument #2 | !Type |!Returned value |
| collection | [[Collection object|Collection]] | property-name | String |||Variant or Variant array. |
| form | [[Form object|Form]] |~|~|||Variant. |
| control | [[Control object|Control]] |~|~| index | absent |~|
|~|~|~|~|~| Integer<br />Long |Variant (or index-th array entry). |
| optiongroup | [[Optiongroup object|OptionGroup]] |~|~|||Variant. |
| subform | [[Subform object|SubForm]] |~|~| index | absent |Variant or Variant array. |
|~|~|~|~|~| Integer<br />Long |Variant (or index-th array entry). |
| property | [[Property object|Property]] |~|~|||Variant or Variant array. |
| event | [[Event object|Event]] |~|~|||~|
!!!Remarks
The //index// argument must have a (integer or long) value between 0 and the size of the array associated with the considered //property// - 1
!!!Error messages
|Argument nr.X is invalid |
|Property '...' not applicable in this context |
|Out of array range or incorrect array size for property '...' |
!!!See also
[[Property]]
[[Properties]]
[[hasProperty]]
[[setProperty]]
!!!Example
The //getValue// function returns a property of an [[object|Object Model]] designated by its [[shortcut notation|ShortCut Notation]].
!!!Syntax
{{{getValue(}}}//shortcut//{{{)}}}
| !Shortcut | !Returned value |
| String | Variant |
!!!Remark
If the last component of the //shortcut// is not a property (i.e. the last operator is not a ".") then the property [[Value]] is assumed.
!!!See also
[[ShortCut Notation]]
[[getObject]]
[[setValue]]
The [[Value]] property
!!!Example
//{{{
getValue("Forms!myForm!mySubForm.Form!myGridControl!mySubControl.ControlTipText")
//}}}
is equivalent to
//{{{
Forms("myForm").Controls("mySubForm").Form.Controls("myGridControl").Controls("mySubControl").ControlTipText
//}}}
The //hasProperty// method returns //True// if an [[object|Object Model]] has a specific //property//.
!!!Applies to ...
| !Object | !Description |
|[[Collection]] |An array of objects accessible via their index |
|[[Database]] |The single database to which the Base application is connected |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice// database form |
|[[Control]] |The representation of a control within a Form or Subform.<br />The control may be any control type including a [[gridcontrol|GridControl]]. |
|[[SubForm]] |Identifies a specific control which is a subform of a database form or another subform |
|[[OptionGroup]]|The representation of a set of [[RadioButtons|RadioButton]] having the same name. |
|[[Property]] |A name-value pair allowing objects introspection |
|[[Event|Events]] |A description of an occurred form or control event |
!!!Syntax
//object//.{{{hasProperty(}}}//property-name//{{{)}}}
| !Argument | !Type |!Returned value |
| property-name | String | Boolean |
!!!Error messages
|Argument nr.X is invalid |
!!!See also
[[Property]]
[[Properties]]
[[getProperty]]
[[setProperty]]
!!!Example
<<tiddler "setProperty example">>
The //setFocus// method moves the focus to the specified form or to the specified control on the active form.
!!!Applies to ...
| !Object | !Description |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice Base// database [[form|Form]] |
|[[Control]] |The representation of a control within a [[form|Form]], a [[subform|SubForm]] or a [[gridcontrol|GridControl]] |
!!!Syntax
//form//.{{{setFocus}}}
//control//.{{{setFocus}}}
!!!Returned value
//True// if success.
!!!Remarks
!!!Error messages
|Control '...' not found in gridcontrol '...' |
!!!See also
[[Bookmark]]
[[FindRecord]]
[[GoToRecord]]
[[SelectObject]]
!!!Example
<<tiddler "setFocus example">>
Set focus on named control
//{{{
Dim sControl As String
getObject("Forms!myForm!myControl").setFocus
//}}}
The //setProperty// method modifies the current value of any modifiable property of [[objects|Object Model]].
!!!Applies to ...
| !Object | !Description |
|[[Form]] |The representation of an //~OpenOffice/~LibreOffice Base// database form. |
|[[Control]] |The representation of a control within a Form or Subform.<br />The control may be any control type including a [[gridcontrol|GridControl]]. |
|[[SubForm]] |Identifies a specific control which is a subform of a database form or another subform. |
|[[OptionGroup]] |Identifies a group of radio buttons within a form or a subform. |
!!!Syntax
//form//.{{{setProperty(}}}//property-name, value//{{{)}}}
//control//.{{{setProperty(}}}//property-name, value//{{{)}}}
//control//.{{{setProperty(}}}//property-name, value, index//{{{)}}}
//subform//.{{{setProperty(}}}//property-name, value//{{{)}}}
//subform//.{{{setProperty(}}}//property-name, value, index//{{{)}}}
//optiongroup//.{{{setProperty(}}}//property-name, value//{{{)}}}
| !Applied to | !Type | !Argument #1 | !Type | !Argument #2 | !Type | !Argument #3 | !Type | !Returned value |
| form | [[Form object|Form]] | property-name | String | value | Variant |||//True// if success. |
| control | [[Control object|Control]] |~|~|~|~| index | absent |~|
|~|~|~|~|~|~|~| Integer<br />Long |~|
| subform | [[Subform object|SubForm]] |~|~|~|~| index | absent |~|
|~|~|~|~|~|~|~| Integer<br />Long |~|
| optiongroup | [[Optiongroup object|OptionGroup]] |~|~|~|~|||~|
!!!Remarks
The //index// argument must have a (integer or long) value between 0 and the size of the array associated with the considered //property// - 1.
!!!Error messages
|Argument nr.X is invalid |
|Property '...' not applicable in this context |
|Value '...' is invalid for property '...' |
|Out of array range or incorrect array size for property '...' |
!!!See also
[[Property]]
[[Properties]]
[[hasProperty]]
[[getProperty]]
!!!Example
<<tiddler "setProperty example">>
Set all enabled controls on a form in italic
//{{{
Dim ofForm As Object, i As Integer, iCount As Integer, ocControl As Object
Set ofForm = Forms("myForm")
iCount = ofForm.Controls().Count
For i = 0 To iCount - 1
Set ocControl = ofForm.Controls(i)
If ocControl.hasProperty("FONTITALIC") Then
If ocControl.hasProperty("ENABLED") Then
If ocControl.Enabled Then ocControl.setProperty("FONTITALIC", True)
End If
End If
Next i
//}}}
The //setValue// function sets a property of an [[object|Object Model]] designated by its [[shortcut notation|ShortCut Notation]].
!!!Syntax
{{{setValue(}}}//shortcut, value//{{{)}}}
| !Shortcut | !Value |!Returned value |
| String | Variant |Boolean. True if success. |
!!!Remark
If the last component of the //shortcut// is not a property (i.e. the last operator is not a ".") then the property [[Value]] is assumed.
The //setValue// does not allow to set a single element of an array if the property value is an array. However setting all the elements at once is allowed.
!!!See also
[[ShortCut Notation]]
[[getObject]]
[[getValue]]
The [[Value]] property
!!!Example
//{{{
setValue("Forms!myForm!mySubForm.Form!myGridControl!mySubControl.ControlTipText", "New tip")
//}}}
is equivalent to
//{{{
Forms("myForm").Controls("mySubForm").Form.Controls("myGridControl").Controls("mySubControl").ControlTipText = "New tip"
//}}}
Type the text for 'systemConfig'