1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?> 2cdf0e10cSrcweir 382a1df74SAndrew Rist<!--*********************************************************** 480bc1aa6Smseidel * 582a1df74SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 682a1df74SAndrew Rist * or more contributor license agreements. See the NOTICE file 782a1df74SAndrew Rist * distributed with this work for additional information 882a1df74SAndrew Rist * regarding copyright ownership. The ASF licenses this file 982a1df74SAndrew Rist * to you under the Apache License, Version 2.0 (the 1082a1df74SAndrew Rist * "License"); you may not use this file except in compliance 1182a1df74SAndrew Rist * with the License. You may obtain a copy of the License at 1280bc1aa6Smseidel * 1382a1df74SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 1480bc1aa6Smseidel * 1582a1df74SAndrew Rist * Unless required by applicable law or agreed to in writing, 1682a1df74SAndrew Rist * software distributed under the License is distributed on an 1782a1df74SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 1882a1df74SAndrew Rist * KIND, either express or implied. See the License for the 1982a1df74SAndrew Rist * specific language governing permissions and limitations 2082a1df74SAndrew Rist * under the License. 2180bc1aa6Smseidel * 2282a1df74SAndrew Rist ***********************************************************--> 2382a1df74SAndrew Rist 24cdf0e10cSrcweir<helpdocument version="1.0"> 25cdf0e10cSrcweir<meta> 26cdf0e10cSrcweir<topic id="textsbasicguidesample_codexml" indexer="include" status="PUBLISH"> 27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Programming Examples for Controls in the Dialog Editor</title> 28cdf0e10cSrcweir<filename>/text/sbasic/guide/sample_code.xhp</filename> 29cdf0e10cSrcweir</topic> 30cdf0e10cSrcweir</meta> 31cdf0e10cSrcweir<body> 32*88cae784Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3155338"> 33*88cae784Smseidel<bookmark_value>programming examples for controls</bookmark_value> 34cdf0e10cSrcweir<bookmark_value>dialogs;loading (example)</bookmark_value> 35cdf0e10cSrcweir<bookmark_value>dialogs;displaying (example)</bookmark_value> 36cdf0e10cSrcweir<bookmark_value>controls;reading or editing properties (example)</bookmark_value> 37cdf0e10cSrcweir<bookmark_value>list boxes;removing entries from (example)</bookmark_value> 38cdf0e10cSrcweir<bookmark_value>list boxes;adding entries to (example)</bookmark_value> 39cdf0e10cSrcweir<bookmark_value>examples; programming controls</bookmark_value> 40cdf0e10cSrcweir<bookmark_value>dialog editor;programming examples for controls</bookmark_value> 41cdf0e10cSrcweir</bookmark> 42cdf0e10cSrcweir<paragraph role="heading" id="hd_id3155338" xml-lang="en-US" level="1" l10n="U" oldref="1"><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> 43cdf0e10cSrcweir</variable></paragraph> 44cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153031" xml-lang="en-US" l10n="CHG" oldref="2">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> 45cdf0e10cSrcweir<paragraph role="warning" id="par_id3154141" xml-lang="en-US" l10n="U" oldref="3">Be consistent with uppercase and lowercase letter when you attach a control to an object variable.</paragraph> 46cdf0e10cSrcweir<paragraph role="heading" id="hd_id3154909" xml-lang="en-US" level="3" l10n="U" oldref="4">Global Function for Loading Dialogs</paragraph> 47cdf0e10cSrcweir<paragraph role="code" id="par_id3153193" xml-lang="en-US" l10n="U" oldref="73">Function LoadDialog(Libname as String, DialogName as String, Optional oLibContainer)</paragraph> 48cdf0e10cSrcweir<paragraph role="code" id="par_id3145787" xml-lang="en-US" l10n="U" oldref="74">Dim oLib as Object</paragraph> 49cdf0e10cSrcweir<paragraph role="code" id="par_id3148576" xml-lang="en-US" l10n="U" oldref="75">Dim oLibDialog as Object</paragraph> 50cdf0e10cSrcweir<paragraph role="code" id="par_id3153726" xml-lang="en-US" l10n="U" oldref="76">Dim oRuntimeDialog as Object</paragraph> 51cdf0e10cSrcweir<paragraph role="code" id="par_id3149261" xml-lang="en-US" l10n="U" oldref="77">If IsMissing(oLibContainer ) then</paragraph> 52cdf0e10cSrcweir<paragraph role="code" id="par_id3148646" xml-lang="en-US" l10n="U" oldref="78">oLibContainer = DialogLibraries</paragraph> 53cdf0e10cSrcweir<paragraph role="code" id="par_id3151115" xml-lang="en-US" l10n="U" oldref="79">End If</paragraph> 54cdf0e10cSrcweir<paragraph role="code" id="par_id3146986" xml-lang="en-US" l10n="U" oldref="80">oLibContainer.LoadLibrary(LibName)</paragraph> 55cdf0e10cSrcweir<paragraph role="code" id="par_id3145366" xml-lang="en-US" l10n="U" oldref="81">oLib = oLibContainer.GetByName(Libname)</paragraph> 56cdf0e10cSrcweir<paragraph role="code" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="82">oLibDialog = oLib.GetByName(DialogName)</paragraph> 57cdf0e10cSrcweir<paragraph role="code" id="par_id3144764" xml-lang="en-US" l10n="U" oldref="83">oRuntimeDialog = CreateUnoDialog(oLibDialog)</paragraph> 58cdf0e10cSrcweir<paragraph role="code" id="par_id3153876" xml-lang="en-US" l10n="U" oldref="84">LoadDialog() = oRuntimeDialog</paragraph> 59cdf0e10cSrcweir<paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U" oldref="85">End Function</paragraph> 60cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149412" xml-lang="en-US" level="3" l10n="U" oldref="18">Displaying a Dialog</paragraph> 61cdf0e10cSrcweir<paragraph role="code" id="par_id3145801" xml-lang="en-US" l10n="U" oldref="86">rem global definition of variables</paragraph> 62cdf0e10cSrcweir<paragraph role="code" id="par_id3150716" xml-lang="en-US" l10n="U" oldref="87">Dim oDialog1 AS Object</paragraph> 63cdf0e10cSrcweir<paragraph role="code" id="par_id3154510" xml-lang="en-US" l10n="U" oldref="88">Sub StartDialog1</paragraph> 64cdf0e10cSrcweir<paragraph role="code" id="par_id3146913" xml-lang="en-US" l10n="U" oldref="162">BasicLibraries.LoadLibrary("Tools")</paragraph> 65cdf0e10cSrcweir<paragraph role="code" id="par_id3150327" xml-lang="en-US" l10n="U" oldref="89">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> 66cdf0e10cSrcweir<paragraph role="code" id="par_id3155767" xml-lang="en-US" l10n="U" oldref="92">oDialog1.Execute()</paragraph> 67cdf0e10cSrcweir<paragraph role="code" id="par_id3149019" xml-lang="en-US" l10n="U" oldref="93">end sub</paragraph> 68cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150042" xml-lang="en-US" level="3" l10n="U" oldref="27">Read or Edit Properties of Controls in the Program</paragraph> 69cdf0e10cSrcweir<paragraph role="code" id="par_id3159267" xml-lang="en-US" l10n="U" oldref="136">Sub Sample1</paragraph> 70cdf0e10cSrcweir<paragraph role="code" id="par_id3155335" xml-lang="en-US" l10n="U" oldref="163">BasicLibraries.LoadLibrary("Tools")</paragraph> 71cdf0e10cSrcweir<paragraph role="code" id="par_id3163808" xml-lang="en-US" l10n="U" oldref="137">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> 72cdf0e10cSrcweir<paragraph role="code" id="par_id3145232" xml-lang="en-US" l10n="U" oldref="138">REM get dialog model</paragraph> 73cdf0e10cSrcweir<paragraph role="code" id="par_id3146316" xml-lang="en-US" l10n="U" oldref="139">oDialog1Model = oDialog1.Model</paragraph> 74cdf0e10cSrcweir<paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U" oldref="140">REM display text of Label1</paragraph> 75cdf0e10cSrcweir<paragraph role="code" id="par_id3150301" xml-lang="en-US" l10n="U" oldref="141">oLabel1 = oDialog1.GetControl("Label1")</paragraph> 76cdf0e10cSrcweir<paragraph role="code" id="par_id3152584" xml-lang="en-US" l10n="U" oldref="142">MsgBox oLabel1.Text</paragraph> 77cdf0e10cSrcweir<paragraph role="code" id="par_id3151277" xml-lang="en-US" l10n="U" oldref="143">REM set new text for control Label1</paragraph> 78cdf0e10cSrcweir<paragraph role="code" id="par_id3154119" xml-lang="en-US" l10n="U" oldref="144">oLabel1.Text = "New Files"</paragraph> 79cdf0e10cSrcweir<paragraph role="code" id="par_id3155115" xml-lang="en-US" l10n="U" oldref="145">REM display model properties for the control CheckBox1</paragraph> 80cdf0e10cSrcweir<paragraph role="code" id="par_id3166426" xml-lang="en-US" l10n="U" oldref="146">oCheckBox1Model = oDialog1Model.CheckBox1</paragraph> 81cdf0e10cSrcweir<paragraph role="code" id="par_id3153270" xml-lang="en-US" l10n="U" oldref="147">MsgBox oCheckBox1Model.Dbg_Properties</paragraph> 82cdf0e10cSrcweir<paragraph role="code" id="par_id3149817" xml-lang="en-US" l10n="U" oldref="148">REM set new state for CheckBox1 for model of control</paragraph> 83cdf0e10cSrcweir<paragraph role="code" id="par_id3145134" xml-lang="en-US" l10n="U" oldref="149">oCheckBox1Model.State = 1</paragraph> 84cdf0e10cSrcweir<paragraph role="code" id="par_id3159102" xml-lang="en-US" l10n="U" oldref="150">REM display model properties for control CommandButton1</paragraph> 85cdf0e10cSrcweir<paragraph role="code" id="par_id3152777" xml-lang="en-US" l10n="U" oldref="151">oCMD1Model = oDialog1Model.CommandButton1</paragraph> 86cdf0e10cSrcweir<paragraph role="code" id="par_id3149209" xml-lang="en-US" l10n="U" oldref="152">MsgBox oCMD1Model.Dbg_Properties</paragraph> 87cdf0e10cSrcweir<paragraph role="code" id="par_id3150368" xml-lang="en-US" l10n="U" oldref="153">REM display properties of control CommandButton1</paragraph> 88cdf0e10cSrcweir<paragraph role="code" id="par_id3150883" xml-lang="en-US" l10n="U" oldref="154">oCMD1 = oDialog1.GetControl("CommandButton1")</paragraph> 89cdf0e10cSrcweir<paragraph role="code" id="par_id3155380" xml-lang="en-US" l10n="U" oldref="155">MsgBox oCMD1.Dbg_Properties</paragraph> 90cdf0e10cSrcweir<paragraph role="code" id="par_id3150201" xml-lang="en-US" l10n="U" oldref="156">REM execute dialog</paragraph> 91cdf0e10cSrcweir<paragraph role="code" id="par_id3154485" xml-lang="en-US" l10n="U" oldref="157">oDialog1.Execute()</paragraph> 92cdf0e10cSrcweir<paragraph role="code" id="par_id3146115" xml-lang="en-US" l10n="U" oldref="158">End Sub</paragraph> 93cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145387" xml-lang="en-US" level="3" l10n="U" oldref="55">Add an Entry to a ListBox</paragraph> 94cdf0e10cSrcweir<paragraph role="code" id="par_id3155088" xml-lang="en-US" l10n="U" oldref="122">Sub AddEntry</paragraph> 95cdf0e10cSrcweir<paragraph role="code" id="par_id3154528" xml-lang="en-US" l10n="U" oldref="164">BasicLibraries.LoadLibrary("Tools")</paragraph> 96cdf0e10cSrcweir<paragraph role="code" id="par_id3159222" xml-lang="en-US" l10n="U" oldref="159">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> 97cdf0e10cSrcweir<paragraph role="code" id="par_id3148700" xml-lang="en-US" l10n="U" oldref="123">REM adds a new entry to the ListBox</paragraph> 98cdf0e10cSrcweir<paragraph role="code" id="par_id3159173" xml-lang="en-US" l10n="U" oldref="124">oDialog1Model = oDialog1.Model</paragraph> 99cdf0e10cSrcweir<paragraph role="code" id="par_id3153305" xml-lang="en-US" l10n="U" oldref="125">oListBox = oDialog1.GetControl("ListBox1")</paragraph> 100cdf0e10cSrcweir<paragraph role="code" id="par_id3153914" xml-lang="en-US" l10n="U" oldref="126">dim iCount as integer</paragraph> 101cdf0e10cSrcweir<paragraph role="code" id="par_id3151243" xml-lang="en-US" l10n="U" oldref="127">iCount = oListbox.ItemCount</paragraph> 102cdf0e10cSrcweir<paragraph role="code" id="par_id3144504" xml-lang="en-US" l10n="U" oldref="128">oListbox.additem("New Item" & iCount,0)</paragraph> 103cdf0e10cSrcweir<paragraph role="code" id="par_id3149328" xml-lang="en-US" l10n="U" oldref="129">end sub</paragraph> 104cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147071" xml-lang="en-US" level="3" l10n="U" oldref="64">Remove an Entry from a ListBox</paragraph> 105cdf0e10cSrcweir<paragraph role="code" id="par_id3159095" xml-lang="en-US" l10n="U" oldref="130">Sub RemoveEntry</paragraph> 106cdf0e10cSrcweir<paragraph role="code" id="par_id3154958" xml-lang="en-US" l10n="U" oldref="165">BasicLibraries.LoadLibrary("Tools")</paragraph> 107cdf0e10cSrcweir<paragraph role="code" id="par_id3149443" xml-lang="en-US" l10n="U" oldref="160">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph> 108cdf0e10cSrcweir<paragraph role="code" id="par_id3153247" xml-lang="en-US" l10n="U" oldref="131">REM remove the first entry from the ListBox</paragraph> 109cdf0e10cSrcweir<paragraph role="code" id="par_id3151302" xml-lang="en-US" l10n="U" oldref="132">oDialog1Model = oDialog1.Model</paragraph> 110cdf0e10cSrcweir<paragraph role="code" id="par_id3153976" xml-lang="en-US" l10n="U" oldref="133">oListBox = oDialog1.GetControl("ListBox1")</paragraph> 111cdf0e10cSrcweir<paragraph role="code" id="par_id3155383" xml-lang="en-US" l10n="U" oldref="134">oListbox.removeitems(0,1)</paragraph> 112cdf0e10cSrcweir<paragraph role="code" id="par_id3150892" xml-lang="en-US" l10n="U" oldref="135">end sub</paragraph> 113cdf0e10cSrcweir<section id="relatedtopics"> 114cdf0e10cSrcweir<embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> 115cdf0e10cSrcweir<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> 116cdf0e10cSrcweir<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> 117cdf0e10cSrcweir<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> 118cdf0e10cSrcweir</section> 119cdf0e10cSrcweir</body> 120cdf0e10cSrcweir</helpdocument> 121