merge the formfield patch from ooo-build
[ooovba.git] / helpcontent2 / source / text / swriter / 01 / 04090003.xhp
blob5a0fbc53ffd464d4ae4fda004dcf6fe6a454dc5f
1 <?xml version="1.0" encoding="UTF-8"?>
2 <helpdocument version="1.0">
4 <!--
5 ***********************************************************************
7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 *
9 * Copyright 2008 by Sun Microsystems, Inc.
11 * OpenOffice.org - a multi-platform office productivity suite
13 * $RCSfile: 04090003.xhp,v $
14 * $Revision: 1.7.4.1 $
16 * This file is part of OpenOffice.org.
18 * OpenOffice.org is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU Lesser General Public License version 3
20 * only, as published by the Free Software Foundation.
22 * OpenOffice.org is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Lesser General Public License version 3 for more details
26 * (a copy is included in the LICENSE file that accompanied this code).
28 * You should have received a copy of the GNU Lesser General Public License
29 * version 3 along with OpenOffice.org. If not, see
30 * <http://www.openoffice.org/license.html>
31 * for a copy of the LGPLv3 License.
33 ************************************************************************
34 -->
37 <meta>
38 <topic id="textswriter0104090003xml" indexer="include">
39 <title id="tit" xml-lang="en-US">Functions</title>
40 <filename>/text/swriter/01/04090003.xhp</filename>
41 </topic>
42 </meta>
43 <body>
44 <section id="funktionen">
45 <bookmark xml-lang="en-US" branch="hid/HID_FLD_FUNC" id="bm_id3156382" localize="false"/>
46 <paragraph role="heading" id="hd_id3149123" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/swriter/01/04090003.xhp" name="Functions">Functions</link></paragraph>
47 <bookmark xml-lang="en-US" branch="hid/SW_EDIT_TP_FLD_FUNC_ED_FUNCNAME" id="bm_id3149875" localize="false"/>
48 <bookmark xml-lang="en-US" branch="hid/SW_EDIT_TP_FLD_FUNC_ED_FUNCVALUE" id="bm_id3150251" localize="false"/>
49 <paragraph role="paragraph" id="par_id3150343" xml-lang="en-US" l10n="U" oldref="45"><ahelp hid="SW_EDIT_TP_FLD_FUNC_ED_FUNCVALUE" visibility="hidden">Sets additional function parameters for fields. The type of parameter depends on the field type that you select.</ahelp></paragraph>
50 <paragraph role="paragraph" id="par_id3151242" xml-lang="en-US" l10n="U" oldref="2">Depending on the field type that you select, you can assign conditions to certain functions. For example, you can define a field that executes a macro when you click the field in the document, or a condition that, when met, hides a field. You can also define placeholder fields that insert graphics, tables, frames and other objects into your document when needed.</paragraph>
51 </section>
52 <section id="howtoget">
53 <embed href="text/swriter/00/00000404.xhp#feldfunktionen"/>
54 </section>
55 <bookmark xml-lang="en-US" branch="hid/SW_LISTBOX_TP_FLD_FUNC_LB_FUNCTYPE" id="bm_id3146964" localize="false"/>
56 <paragraph role="paragraph" id="par_id0902200804352037" xml-lang="en-US" l10n="NEW"><ahelp hid="." visibility="hidden">Lists the available field types. To add a field to your document, click a field type, click a field in the <emph>Select </emph>list, and then click <emph>Insert</emph>.</ahelp></paragraph>
57 <embed href="text/swriter/01/04090001.xhp#feldtyp"/>
58 <table id="tbl_id3147403">
59 <tablerow>
60 <tablecell>
61 <paragraph role="tablehead" id="par_id3150537" xml-lang="en-US" l10n="U" oldref="3">Type</paragraph>
62 </tablecell>
63 <tablecell>
64 <paragraph role="tablehead" id="par_id3155623" xml-lang="en-US" l10n="U" oldref="4">Meaning</paragraph>
65 </tablecell>
66 </tablerow>
67 <tablerow>
68 <tablecell>
69 <paragraph role="tablecontent" id="par_id3152999" xml-lang="en-US" l10n="U" oldref="5">Conditional text</paragraph>
70 </tablecell>
71 <tablecell>
72 <paragraph role="tablecontent" id="par_id3149881" xml-lang="en-US" l10n="U" oldref="6">Inserts text if a certain <link href="text/swriter/01/04090200.xhp" name="condition">condition</link> is met. For example, enter "sun eq 1" in the <emph>Condition</emph> box, and then the text that you want to insert when the variable "sun" equals "1" in the <emph>Then </emph>box. If you want, you can also enter the text that you want to display when this condition is not met in the <emph>Else</emph> box. To define the variable "sun", click the <link href="text/swriter/01/04090005.xhp" name="Variables"><emph>Variables</emph></link> tab, select "Set variable", type "sun" in the<emph> Name</emph> box, and its value in the<emph> Value</emph> box.</paragraph>
73 </tablecell>
74 </tablerow>
75 <tablerow>
76 <tablecell>
77 <paragraph role="tablecontent" id="par_id3153719" xml-lang="en-US" l10n="U" oldref="47">Input list</paragraph>
78 </tablecell>
79 <tablecell>
80 <paragraph role="tablecontent" id="par_id3147564" xml-lang="en-US" l10n="U" oldref="48">Inserts a text field that displays one item from a list. You can add, edit, and remove items, and change their order in the list. Click an <emph>Input list</emph> field in your document or press Ctrl+Shift+F9 to display the <link href="text/swriter/01/04090003.xhp" name="Choose Item"><emph>Choose Item</emph></link> dialog.</paragraph>
81 </tablecell>
82 </tablerow>
83 <tablerow>
84 <tablecell>
85 <paragraph role="tablecontent" id="par_id3153146" xml-lang="en-US" l10n="U" oldref="7">Input field</paragraph>
86 </tablecell>
87 <tablecell>
88 <paragraph role="tablecontent" id="par_id3149287" xml-lang="en-US" l10n="U" oldref="8">Inserts a text field that you can open by <link href="text/swriter/01/04090100.xhp" name="clicking">clicking</link> it in the document. You can then change the text that is displayed.</paragraph>
89 </tablecell>
90 </tablerow>
91 <tablerow>
92 <tablecell>
93 <paragraph role="tablecontent" id="par_id3154691" xml-lang="en-US" l10n="U" oldref="9">Execute macro</paragraph>
94 </tablecell>
95 <tablecell>
96 <paragraph role="tablecontent" id="par_id3147515" xml-lang="en-US" l10n="U" oldref="10">Inserts a text field that runs a macro when you click the field in the document. To assign a macro to the field, click the <emph>Macro</emph> button. </paragraph>
97 </tablecell>
98 </tablerow>
99 <tablerow>
100 <tablecell>
101 <paragraph role="tablecontent" id="par_id3152946" xml-lang="en-US" l10n="U" oldref="11">Placeholder</paragraph>
102 </tablecell>
103 <tablecell>
104 <paragraph role="tablecontent" id="par_id3153527" xml-lang="en-US" l10n="U" oldref="12">Inserts a placeholder field in the document, for example, for graphics. When you click a placeholder field in the document, you are prompted to insert the item that is missing.</paragraph>
105 </tablecell>
106 </tablerow>
107 <tablerow>
108 <tablecell>
109 <paragraph role="tablecontent" id="par_id3150973" xml-lang="en-US" l10n="U" oldref="13">Hidden text</paragraph>
110 </tablecell>
111 <tablecell>
112 <paragraph role="tablecontent" id="par_id3147524" xml-lang="en-US" l10n="CHG" oldref="14">Inserts a text field that is hidden when the condition that you specify is met. To use this function, choose <link href="text/shared/optionen/01040600.xhp" name="Tools - Options - Text Document - Formatting Aids"><emph>Tools - Options - %PRODUCTNAME Writer - Formatting Aids</emph></link> and clear the <emph>Fields: Hidden text</emph> check box.</paragraph>
113 </tablecell>
114 </tablerow>
115 <tablerow>
116 <tablecell>
117 <paragraph role="tablecontent" id="par_id3154480" xml-lang="en-US" l10n="U" oldref="15">Hidden Paragraph</paragraph>
118 </tablecell>
119 <tablecell>
120 <paragraph role="tablecontent" id="par_id3153677" xml-lang="en-US" l10n="CHG" oldref="16">Hides a paragraph when the condition that you specify is met. To use this function, choose <link href="text/shared/optionen/01040600.xhp" name="Tools - Options - Text Document - Formatting Aids"><emph>Tools - Options - %PRODUCTNAME Writer - Formatting Aids</emph></link> and clear the <emph>Fields: Hidden paragraph</emph> check box.</paragraph>
121 </tablecell>
122 </tablerow>
123 <tablerow>
124 <tablecell>
125 <paragraph role="tablecontent" id="par_id3154192" xml-lang="en-US" l10n="U" oldref="39">Combine characters </paragraph>
126 </tablecell>
127 <tablecell>
128 <paragraph role="tablecontent" id="par_id3159199" xml-lang="en-US" l10n="U" oldref="42">Combines up to 6 characters, so that they behave as a single character. This feature is only available when Asian fonts are supported.</paragraph>
129 </tablecell>
130 </tablerow>
131 </table>
132 <embed href="text/swriter/01/04090001.xhp#hinweis"/>
133 <bookmark xml-lang="en-US" branch="hid/SW_LISTBOX_TP_FLD_FUNC_LB_FUNCFORMAT" id="bm_id3149307" localize="false"/>
134 <paragraph role="paragraph" id="par_id0902200804352213" xml-lang="en-US" l10n="NEW"><ahelp hid="." visibility="hidden">Click the format that you want to apply to the selected field, or click "Additional formats" to define a custom format.</ahelp></paragraph>
135 <embed href="text/swriter/01/04090001.xhp#format"/>
136 <paragraph role="paragraph" id="par_id3151329" xml-lang="en-US" l10n="U" oldref="17">For function fields, the format field is only used for fields of the type placeholder. Here, the format determines the object for which the placeholder stands.</paragraph>
137 <section id="bedingung">
138 <paragraph role="heading" id="hd_id3149494" xml-lang="en-US" level="2" l10n="U" oldref="18">Condition</paragraph>
139 <paragraph role="paragraph" id="par_id3143281" xml-lang="en-US" l10n="U" oldref="19"><ahelp hid="SW:EDIT:TP_FLD_DB:ED_DBCONDITION">For fields linked to a <link href="text/swriter/01/04090200.xhp" name="condition">condition</link>, enter the criteria here.</ahelp></paragraph>
140 </section>
141 <bookmark xml-lang="en-US" branch="hid/SW_EDIT_TP_FLD_FUNC_ED_FUNCCOND1" id="bm_id3151259" localize="false"/>
142 <bookmark xml-lang="en-US" branch="hid/SW_EDIT_TP_FLD_FUNC_ED_FUNCCOND2" id="bm_id3151262" localize="false"/>
143 <paragraph role="heading" id="hd_id3151248" xml-lang="en-US" level="2" l10n="U" oldref="20">Then, Else</paragraph>
144 <paragraph role="paragraph" id="par_id3154830" xml-lang="en-US" l10n="U" oldref="21"><ahelp hid="SW_EDIT_TP_FLD_FUNC_ED_FUNCCOND2">Enter the text to display when the condition is met in the <emph>Then </emph>box, and the text to display when the condition is not met in the <emph>Else </emph>box.</ahelp></paragraph>
145 <paragraph role="paragraph" id="par_id3146865" xml-lang="en-US" l10n="U" oldref="22">You can also insert database fields in the <emph>Then </emph>and <emph>Else </emph>boxes using the format "databasename.tablename.fieldname".</paragraph>
146 <paragraph role="note" id="par_id3147583" xml-lang="en-US" l10n="U" oldref="24">If the table or the field name does not exist in a database, nothing is inserted.</paragraph>
147 <paragraph role="note" id="par_id3152585" xml-lang="en-US" l10n="U" oldref="23">If you include the quotes in "databasename.tablename.fieldname", the expression is inserted as text.</paragraph>
148 <section id="hinweis">
149 <paragraph role="heading" id="hd_id3155136" xml-lang="en-US" level="2" l10n="U" oldref="26">Reference</paragraph>
150 <paragraph role="paragraph" id="par_id3155149" xml-lang="en-US" l10n="U" oldref="27">Type the text that you want to display in the field. If you are inserting a placeholder field, type the text that you want to display as a help tip when you rest the mouse pointer over the field. </paragraph>
151 </section>
152 <paragraph role="heading" id="hd_id3147071" xml-lang="en-US" level="2" l10n="CHG" oldref="28">Format<comment>UFI: see spec "Macro Selector..."</comment></paragraph>
153 <paragraph role="paragraph" id="par_id3147084" xml-lang="en-US" l10n="U" oldref="29">Select the macro that you want to run when the field is clicked.</paragraph>
154 <paragraph role="heading" id="hd_id3154384" xml-lang="en-US" level="2" l10n="U" oldref="30">Macro name</paragraph>
155 <paragraph role="paragraph" id="par_id3153351" xml-lang="en-US" l10n="U" oldref="31">Displays the name of the selected macro.</paragraph>
156 <paragraph role="heading" id="hd_id3156269" xml-lang="en-US" level="2" l10n="U" oldref="32">Placeholder</paragraph>
157 <paragraph role="paragraph" id="par_id3156282" xml-lang="en-US" l10n="U" oldref="33">Type the text that you want to appear in the placeholder field.</paragraph>
158 <paragraph role="heading" id="hd_id3150587" xml-lang="en-US" level="2" l10n="U" oldref="34">Hidden text</paragraph>
159 <paragraph role="paragraph" id="par_id3149173" xml-lang="en-US" l10n="U" oldref="35">Type the text that you want to hide if a condition is met.</paragraph>
160 <paragraph role="heading" id="hd_id3151028" xml-lang="en-US" level="2" l10n="U" oldref="40">Characters</paragraph>
161 <paragraph role="paragraph" id="par_id3145771" xml-lang="en-US" l10n="U" oldref="43">Enter the characters that you want to combine. You can combine a maximum of 6 characters. This option is only available for the <emph>Combine characters</emph> field type.</paragraph>
162 <paragraph role="heading" id="hd_id3156369" xml-lang="en-US" level="2" l10n="U" oldref="41">Value</paragraph>
163 <paragraph role="paragraph" id="par_id3151370" xml-lang="en-US" l10n="U" oldref="44">Enter a value for the selected field.</paragraph>
164 <section id="makro">
165 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_TP_FLD_FUNC_BT_FUNCMACRO" id="bm_id3148889" localize="false"/>
166 <paragraph role="heading" id="hd_id3148877" xml-lang="en-US" level="2" l10n="U" oldref="36">Macro</paragraph>
167 <paragraph role="paragraph" id="par_id3155912" xml-lang="en-US" l10n="CHG" oldref="37"><ahelp hid="SW_PUSHBUTTON_TP_FLD_FUNC_BT_FUNCMACRO">Opens the <emph>Macro Selector</emph>, where you can choose the macro that will run when you click the selected field in the document.</ahelp> This button is only available for the "Execute macro" function field.</paragraph>
168 </section>
169 <paragraph role="paragraph" id="par_id3150111" xml-lang="en-US" l10n="U" oldref="49">The following controls are displayed for <emph>Input list</emph> fields:</paragraph>
170 <bookmark xml-lang="en-US" branch="hid/SW_EDIT_TP_FLD_FUNC_ED_LISTITEM" id="bm_id3155871" localize="false"/>
171 <paragraph role="heading" id="hd_id3155860" xml-lang="en-US" level="2" l10n="U" oldref="50">Item</paragraph>
172 <paragraph role="paragraph" id="par_id3150688" xml-lang="en-US" l10n="U" oldref="51"><ahelp hid="SW_EDIT_TP_FLD_FUNC_ED_LISTITEM">Enter a new item.</ahelp></paragraph>
173 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTADD" id="bm_id3147425" localize="false"/>
174 <paragraph role="heading" id="hd_id3147413" xml-lang="en-US" level="2" l10n="U" oldref="52">Add</paragraph>
175 <paragraph role="paragraph" id="par_id3147473" xml-lang="en-US" l10n="U" oldref="53"><ahelp hid="SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTADD">Adds the <emph>Item</emph> to the list.</ahelp></paragraph>
176 <bookmark xml-lang="en-US" branch="hid/SW_LISTBOX_TP_FLD_FUNC_LB_LISTITEMS" id="bm_id3147612" localize="false"/>
177 <paragraph role="heading" id="hd_id3147496" xml-lang="en-US" level="2" l10n="U" oldref="54">Items on list</paragraph>
178 <paragraph role="paragraph" id="par_id3147618" xml-lang="en-US" l10n="U" oldref="55"><ahelp hid="SW_LISTBOX_TP_FLD_FUNC_LB_LISTITEMS">Lists the items. The topmost item is shown in the document.</ahelp></paragraph>
179 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTREMOVE" id="bm_id3149552" localize="false"/>
180 <paragraph role="heading" id="hd_id3145263" xml-lang="en-US" level="2" l10n="U" oldref="56">Remove</paragraph>
181 <paragraph role="paragraph" id="par_id3149558" xml-lang="en-US" l10n="U" oldref="57"><ahelp hid="SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTREMOVE">Removes the selected item from the list.</ahelp></paragraph>
182 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTUP" id="bm_id3155964" localize="false"/>
183 <paragraph role="heading" id="hd_id3145126" xml-lang="en-US" level="2" l10n="U" oldref="58">Move Up</paragraph>
184 <paragraph role="paragraph" id="par_id3155970" xml-lang="en-US" l10n="U" oldref="59"><ahelp hid="SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTUP">Moves the selected item up in the list.</ahelp></paragraph>
185 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTDOWN" id="bm_id3150562" localize="false"/>
186 <paragraph role="heading" id="hd_id3150549" xml-lang="en-US" level="2" l10n="U" oldref="60">Move Down</paragraph>
187 <paragraph role="paragraph" id="par_id3156221" xml-lang="en-US" l10n="U" oldref="61"><ahelp hid="SW_PUSHBUTTON_TP_FLD_FUNC_PB_LISTDOWN">Moves the selected item down in the list.</ahelp></paragraph>
188 <bookmark xml-lang="en-US" branch="hid/SW_EDIT_TP_FLD_FUNC_ED_LISTNAME" id="bm_id3149226" localize="false"/>
189 <paragraph role="heading" id="hd_id3149215" xml-lang="en-US" level="2" l10n="U" oldref="62">Name</paragraph>
190 <paragraph role="paragraph" id="par_id3147733" xml-lang="en-US" l10n="U" oldref="63"><ahelp hid="SW_EDIT_TP_FLD_FUNC_ED_LISTNAME">Enter a unique name for the <emph>Input list</emph>.</ahelp></paragraph>
191 <bookmark xml-lang="en-US" branch="hid/SW_LISTBOX_DLG_FLD_DROPDOWN_LB_LISTITEMS" id="bm_id3146344" localize="false"/>
192 <paragraph role="heading" id="hd_id3146332" xml-lang="en-US" level="2" l10n="U" oldref="64">Choose Item</paragraph>
193 <paragraph role="paragraph" id="par_id3147455" xml-lang="en-US" l10n="U" oldref="65">This dialog is shown when you click an <emph>Input list</emph> field in the document. </paragraph>
194 <paragraph role="paragraph" id="par_id3149837" xml-lang="en-US" l10n="U" oldref="66"><ahelp hid="SW_LISTBOX_DLG_FLD_DROPDOWN_LB_LISTITEMS">Choose the item that you want to display in the document, then click <emph>OK</emph>.</ahelp></paragraph>
195 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_DLG_FLD_DROPDOWN_PB_EDIT" id="bm_id3148848" localize="false"/>
196 <paragraph role="heading" id="hd_id3147602" xml-lang="en-US" level="2" l10n="U" oldref="67">Edit</paragraph>
197 <paragraph role="paragraph" id="par_id3148855" xml-lang="en-US" l10n="U" oldref="68"><ahelp hid="SW_PUSHBUTTON_DLG_FLD_DROPDOWN_PB_EDIT">Displays the <emph>Edit Fields: Functions</emph> dialog, where you can edit the <emph>Input list</emph>.</ahelp></paragraph>
198 <bookmark xml-lang="en-US" branch="hid/SW_PUSHBUTTON_DLG_FLD_DROPDOWN_PB_NEXT" id="bm_id3155570" localize="false"/>
199 <paragraph role="heading" id="hd_id3155558" xml-lang="en-US" level="2" l10n="U" oldref="69">Next</paragraph>
200 <paragraph role="paragraph" id="par_id3148434" xml-lang="en-US" l10n="U" oldref="70"><ahelp hid="SW_PUSHBUTTON_DLG_FLD_DROPDOWN_PB_NEXT">Closes the current <emph>Input list</emph> and displays the next, if available.</ahelp> You see this button when you open the <emph>Choose Item</emph> dialog by Ctrl+Shift+F9.</paragraph>
201 </body>
202 </helpdocument>