summaryrefslogtreecommitdiff
path: root/helpcontent2/source/text/sbasic/guide/sample_code.xhp
blob: 8f2f45323d164772d1d6f96352b5d41bdc4c8c6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="UTF-8"?>


<!--***********************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2005-01-12T10:40:14">converted from old format - fpe</lastedited>
</history>
</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" 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>
</variable></paragraph>
<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>
<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>
<paragraph role="heading" id="hd_id3154909" xml-lang="en-US" level="3" l10n="U" oldref="4">Global Function for Loading Dialogs</paragraph>
<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>
<paragraph role="code" id="par_id3145787" xml-lang="en-US" l10n="U" oldref="74">Dim oLib as Object</paragraph>
<paragraph role="code" id="par_id3148576" xml-lang="en-US" l10n="U" oldref="75">Dim oLibDialog as Object</paragraph>
<paragraph role="code" id="par_id3153726" xml-lang="en-US" l10n="U" oldref="76">Dim oRuntimeDialog as Object</paragraph>
<paragraph role="code" id="par_id3149261" xml-lang="en-US" l10n="U" oldref="77">If IsMissing(oLibContainer ) then</paragraph>
<paragraph role="code" id="par_id3148646" xml-lang="en-US" l10n="U" oldref="78">oLibContainer = DialogLibraries</paragraph>
<paragraph role="code" id="par_id3151115" xml-lang="en-US" l10n="U" oldref="79">End If</paragraph>
<paragraph role="code" id="par_id3146986" xml-lang="en-US" l10n="U" oldref="80">oLibContainer.LoadLibrary(LibName)</paragraph>
<paragraph role="code" id="par_id3145366" xml-lang="en-US" l10n="U" oldref="81">oLib = oLibContainer.GetByName(Libname)</paragraph>
<paragraph role="code" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="82">oLibDialog = oLib.GetByName(DialogName)</paragraph>
<paragraph role="code" id="par_id3144764" xml-lang="en-US" l10n="U" oldref="83">oRuntimeDialog = CreateUnoDialog(oLibDialog)</paragraph>
<paragraph role="code" id="par_id3153876" xml-lang="en-US" l10n="U" oldref="84">LoadDialog() = oRuntimeDialog</paragraph>
<paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U" oldref="85">End Function</paragraph>
<paragraph role="heading" id="hd_id3149412" xml-lang="en-US" level="3" l10n="U" oldref="18">Displaying a Dialog</paragraph>
<paragraph role="code" id="par_id3145801" xml-lang="en-US" l10n="U" oldref="86">rem global definition of variables</paragraph>
<paragraph role="code" id="par_id3150716" xml-lang="en-US" l10n="U" oldref="87">Dim oDialog1 AS Object</paragraph>
<paragraph role="code" id="par_id3154510" xml-lang="en-US" l10n="U" oldref="88">Sub StartDialog1</paragraph>
<paragraph role="code" id="par_id3146913" xml-lang="en-US" l10n="U" oldref="162">BasicLibraries.LoadLibrary("Tools")</paragraph>
<paragraph role="code" id="par_id3150327" xml-lang="en-US" l10n="U" oldref="89">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph>
<paragraph role="code" id="par_id3155767" xml-lang="en-US" l10n="U" oldref="92">oDialog1.Execute()</paragraph>
<paragraph role="code" id="par_id3149019" xml-lang="en-US" l10n="U" oldref="93">end sub</paragraph>
<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>
<paragraph role="code" id="par_id3159267" xml-lang="en-US" l10n="U" oldref="136">Sub Sample1</paragraph>
<paragraph role="code" id="par_id3155335" xml-lang="en-US" l10n="U" oldref="163">BasicLibraries.LoadLibrary("Tools")</paragraph>
<paragraph role="code" id="par_id3163808" xml-lang="en-US" l10n="U" oldref="137">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph>
<paragraph role="code" id="par_id3145232" xml-lang="en-US" l10n="U" oldref="138">REM get dialog model</paragraph>
<paragraph role="code" id="par_id3146316" xml-lang="en-US" l10n="U" oldref="139">oDialog1Model = oDialog1.Model</paragraph>
<paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U" oldref="140">REM display text of Label1</paragraph>
<paragraph role="code" id="par_id3150301" xml-lang="en-US" l10n="U" oldref="141">oLabel1 = oDialog1.GetControl("Label1")</paragraph>
<paragraph role="code" id="par_id3152584" xml-lang="en-US" l10n="U" oldref="142">MsgBox oLabel1.Text</paragraph>
<paragraph role="code" id="par_id3151277" xml-lang="en-US" l10n="U" oldref="143">REM set new text for control Label1</paragraph>
<paragraph role="code" id="par_id3154119" xml-lang="en-US" l10n="U" oldref="144">oLabel1.Text = "New Files"</paragraph>
<paragraph role="code" id="par_id3155115" xml-lang="en-US" l10n="U" oldref="145">REM display model properties for the control CheckBox1</paragraph>
<paragraph role="code" id="par_id3166426" xml-lang="en-US" l10n="U" oldref="146">oCheckBox1Model = oDialog1Model.CheckBox1</paragraph>
<paragraph role="code" id="par_id3153270" xml-lang="en-US" l10n="U" oldref="147">MsgBox oCheckBox1Model.Dbg_Properties</paragraph>
<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>
<paragraph role="code" id="par_id3145134" xml-lang="en-US" l10n="U" oldref="149">oCheckBox1Model.State = 1</paragraph>
<paragraph role="code" id="par_id3159102" xml-lang="en-US" l10n="U" oldref="150">REM display model properties for control CommandButton1</paragraph>
<paragraph role="code" id="par_id3152777" xml-lang="en-US" l10n="U" oldref="151">oCMD1Model = oDialog1Model.CommandButton1</paragraph>
<paragraph role="code" id="par_id3149209" xml-lang="en-US" l10n="U" oldref="152">MsgBox oCMD1Model.Dbg_Properties</paragraph>
<paragraph role="code" id="par_id3150368" xml-lang="en-US" l10n="U" oldref="153">REM display properties of control CommandButton1</paragraph>
<paragraph role="code" id="par_id3150883" xml-lang="en-US" l10n="U" oldref="154">oCMD1 = oDialog1.GetControl("CommandButton1")</paragraph>
<paragraph role="code" id="par_id3155380" xml-lang="en-US" l10n="U" oldref="155">MsgBox oCMD1.Dbg_Properties</paragraph>
<paragraph role="code" id="par_id3150201" xml-lang="en-US" l10n="U" oldref="156">REM execute dialog</paragraph>
<paragraph role="code" id="par_id3154485" xml-lang="en-US" l10n="U" oldref="157">oDialog1.Execute()</paragraph>
<paragraph role="code" id="par_id3146115" xml-lang="en-US" l10n="U" oldref="158">End Sub</paragraph>
<paragraph role="heading" id="hd_id3145387" xml-lang="en-US" level="3" l10n="U" oldref="55">Add an Entry to a ListBox</paragraph>
<paragraph role="code" id="par_id3155088" xml-lang="en-US" l10n="U" oldref="122">Sub AddEntry</paragraph>
<paragraph role="code" id="par_id3154528" xml-lang="en-US" l10n="U" oldref="164">BasicLibraries.LoadLibrary("Tools")</paragraph>
<paragraph role="code" id="par_id3159222" xml-lang="en-US" l10n="U" oldref="159">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph>
<paragraph role="code" id="par_id3148700" xml-lang="en-US" l10n="U" oldref="123">REM adds a new entry to the ListBox</paragraph>
<paragraph role="code" id="par_id3159173" xml-lang="en-US" l10n="U" oldref="124">oDialog1Model = oDialog1.Model</paragraph>
<paragraph role="code" id="par_id3153305" xml-lang="en-US" l10n="U" oldref="125">oListBox = oDialog1.GetControl("ListBox1")</paragraph>
<paragraph role="code" id="par_id3153914" xml-lang="en-US" l10n="U" oldref="126">dim iCount as integer</paragraph>
<paragraph role="code" id="par_id3151243" xml-lang="en-US" l10n="U" oldref="127">iCount = oListbox.ItemCount</paragraph>
<paragraph role="code" id="par_id3144504" xml-lang="en-US" l10n="U" oldref="128">oListbox.additem("New Item" &amp; iCount,0)</paragraph>
<paragraph role="code" id="par_id3149328" xml-lang="en-US" l10n="U" oldref="129">end sub</paragraph>
<paragraph role="heading" id="hd_id3147071" xml-lang="en-US" level="3" l10n="U" oldref="64">Remove an Entry from a ListBox</paragraph>
<paragraph role="code" id="par_id3159095" xml-lang="en-US" l10n="U" oldref="130">Sub RemoveEntry</paragraph>
<paragraph role="code" id="par_id3154958" xml-lang="en-US" l10n="U" oldref="165">BasicLibraries.LoadLibrary("Tools")</paragraph>
<paragraph role="code" id="par_id3149443" xml-lang="en-US" l10n="U" oldref="160">oDialog1 = LoadDialog("Standard", "Dialog1")</paragraph>
<paragraph role="code" id="par_id3153247" xml-lang="en-US" l10n="U" oldref="131">REM remove the first entry from the ListBox</paragraph>
<paragraph role="code" id="par_id3151302" xml-lang="en-US" l10n="U" oldref="132">oDialog1Model = oDialog1.Model</paragraph>
<paragraph role="code" id="par_id3153976" xml-lang="en-US" l10n="U" oldref="133">oListBox = oDialog1.GetControl("ListBox1")</paragraph>
<paragraph role="code" id="par_id3155383" xml-lang="en-US" l10n="U" oldref="134">oListbox.removeitems(0,1)</paragraph>
<paragraph role="code" id="par_id3150892" xml-lang="en-US" l10n="U" oldref="135">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>