| <?xml version="1.0" encoding="UTF-8"?> |
| |
| <!--*********************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| ***********************************************************--> |
| |
| <helpdocument version="1.0"> |
| <meta> |
| <topic id="textsbasicguidesample_codexml" indexer="include" status="PUBLISH"> |
| <title id="tit" xml-lang="en-US">Programming Examples for Controls in the Dialog Editor</title> |
| <filename>/text/sbasic/guide/sample_code.xhp</filename> |
| </topic> |
| </meta> |
| <body> |
| <bookmark xml-lang="en-US" branch="index" id="bm_id3155338"> |
| <bookmark_value>programming examples for controls</bookmark_value> |
| <bookmark_value>dialogs;loading (example)</bookmark_value> |
| <bookmark_value>dialogs;displaying (example)</bookmark_value> |
| <bookmark_value>controls;reading or editing properties (example)</bookmark_value> |
| <bookmark_value>list boxes;removing entries from (example)</bookmark_value> |
| <bookmark_value>list boxes;adding entries to (example)</bookmark_value> |
| <bookmark_value>examples; programming controls</bookmark_value> |
| <bookmark_value>dialog editor;programming examples for controls</bookmark_value> |
| </bookmark> |
| <paragraph role="heading" id="hd_id3155338" xml-lang="en-US" level="1" l10n="U"><variable id="sample_code"><link href="text/sbasic/guide/sample_code.xhp" name="Programming Examples for Controls in the Dialog Editor">Programming Examples for Controls in the Dialog Editor</link> |
| </variable></paragraph> |
| <paragraph role="paragraph" id="par_id3153031" xml-lang="en-US" l10n="CHG">The following examples are for a new <link href="text/sbasic/guide/create_dialog.xhp" name="dialog">dialog</link> called "Dialog1". Use the tools on the <emph>Toolbox</emph> bar in the dialog editor to create the dialog and add the following controls: a <emph>Check Box</emph> called "CheckBox1", a <emph>Label Field</emph> called "Label1", a <emph>Button</emph> called "CommandButton1", and a <emph>List Box</emph> called "ListBox1".</paragraph> |
| <paragraph role="warning" id="par_id3154141" xml-lang="en-US" l10n="U">Be consistent with uppercase and lowercase letter when you attach a control to an object variable.</paragraph> |
| <paragraph role="heading" id="hd_id3154909" xml-lang="en-US" level="3" l10n="U">Global Function for Loading Dialogs</paragraph> |
| <paragraph role="code" id="par_id3153193" xml-lang="en-US" l10n="U">Function LoadDialog(Libname as String, DialogName as String, Optional oLibContainer)</paragraph> |
| <paragraph role="code" id="par_id3145787" xml-lang="en-US" l10n="U">Dim oLib as Object</paragraph> |
| <paragraph role="code" id="par_id3148576" xml-lang="en-US" l10n="U">Dim oLibDialog as Object</paragraph> |
| <paragraph role="code" id="par_id3153726" xml-lang="en-US" l10n="U">Dim oRuntimeDialog as Object</paragraph> |
| <paragraph role="code" id="par_id3149261" xml-lang="en-US" l10n="U">If IsMissing(oLibContainer ) then</paragraph> |
| <paragraph role="code" id="par_id3148646" xml-lang="en-US" l10n="U">oLibContainer = DialogLibraries</paragraph> |
| <paragraph role="code" id="par_id3151115" xml-lang="en-US" l10n="U">End If</paragraph> |
| <paragraph role="code" id="par_id3146986" xml-lang="en-US" l10n="U">oLibContainer.LoadLibrary(LibName)</paragraph> |
| <paragraph role="code" id="par_id3145366" xml-lang="en-US" l10n="U">oLib = oLibContainer.GetByName(Libname)</paragraph> |
| <paragraph role="code" id="par_id3145271" xml-lang="en-US" l10n="U">oLibDialog = oLib.GetByName(DialogName)</paragraph> |
| <paragraph role="code" id="par_id3144764" xml-lang="en-US" l10n="U">oRuntimeDialog = CreateUnoDialog(oLibDialog)</paragraph> |
| <paragraph role="code" id="par_id3153876" xml-lang="en-US" l10n="U">LoadDialog() = oRuntimeDialog</paragraph> |
| <paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U">End Function</paragraph> |
| <paragraph role="heading" id="hd_id3149412" xml-lang="en-US" level="3" l10n="U">Displaying a Dialog</paragraph> |
| <paragraph role="code" id="par_id3145801" xml-lang="en-US" l10n="U">rem global definition of variables</paragraph> |
| <paragraph role="code" id="par_id3150716" xml-lang="en-US" l10n="U">Dim oDialog1 AS Object</paragraph> |
| <paragraph role="code" id="par_id3154510" xml-lang="en-US" l10n="U">Sub StartDialog1</paragraph> |
| <paragraph role="code" id="par_id3146913" xml-lang="en-US" l10n="U">BasicLibraries.LoadLibrary("Tools")</paragraph> |
| <paragraph role="code" id="par_id3150327" xml-lang="en-US" l10n="U">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> |
| <paragraph role="code" id="par_id3155767" xml-lang="en-US" l10n="U">oDialog1.Execute()</paragraph> |
| <paragraph role="code" id="par_id3149019" xml-lang="en-US" l10n="U">end sub</paragraph> |
| <paragraph role="heading" id="hd_id3150042" xml-lang="en-US" level="3" l10n="U">Read or Edit Properties of Controls in the Program</paragraph> |
| <paragraph role="code" id="par_id3159267" xml-lang="en-US" l10n="U">Sub Sample1</paragraph> |
| <paragraph role="code" id="par_id3155335" xml-lang="en-US" l10n="U">BasicLibraries.LoadLibrary("Tools")</paragraph> |
| <paragraph role="code" id="par_id3163808" xml-lang="en-US" l10n="U">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> |
| <paragraph role="code" id="par_id3145232" xml-lang="en-US" l10n="U">REM get dialog model</paragraph> |
| <paragraph role="code" id="par_id3146316" xml-lang="en-US" l10n="U">oDialog1Model = oDialog1.Model</paragraph> |
| <paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U">REM display text of Label1</paragraph> |
| <paragraph role="code" id="par_id3150301" xml-lang="en-US" l10n="U">oLabel1 = oDialog1.GetControl("Label1")</paragraph> |
| <paragraph role="code" id="par_id3152584" xml-lang="en-US" l10n="U">MsgBox oLabel1.Text</paragraph> |
| <paragraph role="code" id="par_id3151277" xml-lang="en-US" l10n="U">REM set new text for control Label1</paragraph> |
| <paragraph role="code" id="par_id3154119" xml-lang="en-US" l10n="U">oLabel1.Text = "New Files"</paragraph> |
| <paragraph role="code" id="par_id3155115" xml-lang="en-US" l10n="U">REM display model properties for the control CheckBox1</paragraph> |
| <paragraph role="code" id="par_id3166426" xml-lang="en-US" l10n="U">oCheckBox1Model = oDialog1Model.CheckBox1</paragraph> |
| <paragraph role="code" id="par_id3153270" xml-lang="en-US" l10n="U">MsgBox oCheckBox1Model.Dbg_Properties</paragraph> |
| <paragraph role="code" id="par_id3149817" xml-lang="en-US" l10n="U">REM set new state for CheckBox1 for model of control</paragraph> |
| <paragraph role="code" id="par_id3145134" xml-lang="en-US" l10n="U">oCheckBox1Model.State = 1</paragraph> |
| <paragraph role="code" id="par_id3159102" xml-lang="en-US" l10n="U">REM display model properties for control CommandButton1</paragraph> |
| <paragraph role="code" id="par_id3152777" xml-lang="en-US" l10n="U">oCMD1Model = oDialog1Model.CommandButton1</paragraph> |
| <paragraph role="code" id="par_id3149209" xml-lang="en-US" l10n="U">MsgBox oCMD1Model.Dbg_Properties</paragraph> |
| <paragraph role="code" id="par_id3150368" xml-lang="en-US" l10n="U">REM display properties of control CommandButton1</paragraph> |
| <paragraph role="code" id="par_id3150883" xml-lang="en-US" l10n="U">oCMD1 = oDialog1.GetControl("CommandButton1")</paragraph> |
| <paragraph role="code" id="par_id3155380" xml-lang="en-US" l10n="U">MsgBox oCMD1.Dbg_Properties</paragraph> |
| <paragraph role="code" id="par_id3150201" xml-lang="en-US" l10n="U">REM execute dialog</paragraph> |
| <paragraph role="code" id="par_id3154485" xml-lang="en-US" l10n="U">oDialog1.Execute()</paragraph> |
| <paragraph role="code" id="par_id3146115" xml-lang="en-US" l10n="U">End Sub</paragraph> |
| <paragraph role="heading" id="hd_id3145387" xml-lang="en-US" level="3" l10n="U">Add an Entry to a ListBox</paragraph> |
| <paragraph role="code" id="par_id3155088" xml-lang="en-US" l10n="U">Sub AddEntry</paragraph> |
| <paragraph role="code" id="par_id3154528" xml-lang="en-US" l10n="U">BasicLibraries.LoadLibrary("Tools")</paragraph> |
| <paragraph role="code" id="par_id3159222" xml-lang="en-US" l10n="U">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> |
| <paragraph role="code" id="par_id3148700" xml-lang="en-US" l10n="U">REM adds a new entry to the ListBox</paragraph> |
| <paragraph role="code" id="par_id3159173" xml-lang="en-US" l10n="U">oDialog1Model = oDialog1.Model</paragraph> |
| <paragraph role="code" id="par_id3153305" xml-lang="en-US" l10n="U">oListBox = oDialog1.GetControl("ListBox1")</paragraph> |
| <paragraph role="code" id="par_id3153914" xml-lang="en-US" l10n="U">dim iCount as integer</paragraph> |
| <paragraph role="code" id="par_id3151243" xml-lang="en-US" l10n="U">iCount = oListbox.ItemCount</paragraph> |
| <paragraph role="code" id="par_id3144504" xml-lang="en-US" l10n="U">oListbox.additem("New Item" & iCount,0)</paragraph> |
| <paragraph role="code" id="par_id3149328" xml-lang="en-US" l10n="U">end sub</paragraph> |
| <paragraph role="heading" id="hd_id3147071" xml-lang="en-US" level="3" l10n="U">Remove an Entry from a ListBox</paragraph> |
| <paragraph role="code" id="par_id3159095" xml-lang="en-US" l10n="U">Sub RemoveEntry</paragraph> |
| <paragraph role="code" id="par_id3154958" xml-lang="en-US" l10n="U">BasicLibraries.LoadLibrary("Tools")</paragraph> |
| <paragraph role="code" id="par_id3149443" xml-lang="en-US" l10n="U">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> |
| <paragraph role="code" id="par_id3153247" xml-lang="en-US" l10n="U">REM remove the first entry from the ListBox</paragraph> |
| <paragraph role="code" id="par_id3151302" xml-lang="en-US" l10n="U">oDialog1Model = oDialog1.Model</paragraph> |
| <paragraph role="code" id="par_id3153976" xml-lang="en-US" l10n="U">oListBox = oDialog1.GetControl("ListBox1")</paragraph> |
| <paragraph role="code" id="par_id3155383" xml-lang="en-US" l10n="U">oListbox.removeitems(0,1)</paragraph> |
| <paragraph role="code" id="par_id3150892" xml-lang="en-US" l10n="U">end sub</paragraph> |
| <section id="relatedtopics"> |
| <embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> |
| <embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> |
| <embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> |
| <embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> |
| </section> |
| </body> |
| </helpdocument> |
