summaryrefslogtreecommitdiffstats
path: root/helpcontent2/source/text/swriter/01/04090003.xhp
blob: 38f9e93b363f81133d1d2876f1bbb55b4d54174c (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 -->

<meta>
<topic id="textswriter0104090003xml" indexer="include">
<title id="tit" xml-lang="en-US">Functions</title>
<filename>/text/swriter/01/04090003.xhp</filename>
</topic>
</meta>
<body>
<section id="functions">
<h1 id="hd_id3149123" xml-lang="en-US"><link href="text/swriter/01/04090003.xhp" name="Functions">Functions</link></h1>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/name" id="bm_id3149875" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/value" id="bm_id3150251" localize="false"/>
<paragraph role="paragraph" id="par_id3150343" xml-lang="en-US"><ahelp hid="." visibility="hidden">Sets additional function parameters for fields. The type of parameter depends on the field type that you select.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/@@nowidget@@" id="bm_@@nowidget@@" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/FldFuncPage" id="bm_id3156382" localize="false"/>
<paragraph role="paragraph" id="par_id3151242" xml-lang="en-US"><ahelp hid=".">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.</ahelp></paragraph>
</section>
<section id="howtoget">
<embed href="text/swriter/00/00000404.xhp#feldfunktionen"/>
</section>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/type" id="bm_id3146964" localize="false"/>
<paragraph role="paragraph" id="par_id0902200804352037" xml-lang="en-US"><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>
<embed href="text/swriter/01/04090001.xhp#fieldtype"/>
<table id="tbl_id3147403">
<tablerow>
<tablecell>
<paragraph role="tablehead" id="par_id3150537" xml-lang="en-US">Type</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablehead" id="par_id3155623" xml-lang="en-US">Meaning</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3152999" xml-lang="en-US">Conditional text</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3149881" xml-lang="en-US">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>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3153719" xml-lang="en-US">Input list</paragraph>
</tablecell>
<tablecell>
    <paragraph role="tablecontent" id="par_id3147564" xml-lang="en-US">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 <switchinline select="sys"><caseinline select="MAC"><keycode>Command</keycode></caseinline><defaultinline><keycode>Ctrl</keycode></defaultinline></switchinline><keycode>+Shift+F9</keycode> to display the <link href="text/swriter/01/04090003.xhp" name="Choose Item"><emph>Choose Item</emph></link> dialog.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3153146" xml-lang="en-US">Input field</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3149287" xml-lang="en-US">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>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3154691" xml-lang="en-US">Execute macro</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3147515" xml-lang="en-US">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>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3152946" xml-lang="en-US">Placeholder</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3153527" xml-lang="en-US">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>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3150973" xml-lang="en-US">Hidden text</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3147524" xml-lang="en-US">Inserts a text field that is hidden when the condition that you specify is met. To use this function, choose <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - </menuitem><link href="text/shared/optionen/01040200.xhp" name="Text Document - View"><menuitem>%PRODUCTNAME Writer - View</menuitem></link> and clear the <emph>Hidden text</emph> check box.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3154480" xml-lang="en-US">Hidden Paragraph</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3153677" xml-lang="en-US">Hides a paragraph when the condition that you specify is met. To use this function, choose <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><emph> - </emph><link href="text/shared/optionen/01040200.xhp" name="Text Document - View"><menuitem>%PRODUCTNAME Writer - View</menuitem></link> and clear the <emph>Hidden paragraphs</emph> check box.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3154192" xml-lang="en-US">Combine characters </paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3159199" xml-lang="en-US">Combines up to 6 characters, so that they behave as a single character. This feature is only available when Asian fonts are supported.</paragraph>
</tablecell>
</tablerow>
</table>
<section id="selectnote">
<note id="par_id3154631" xml-lang="en-US">The following fields can only be inserted if the corresponding field type is selected in the <emph>Type </emph>list.</note>
</section>

<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/format" id="bm_id3149307" localize="false"/>
<h2 id="hd_id3145595" xml-lang="en-US">Format</h2>
<paragraph role="paragraph" id="par_id3151329" xml-lang="en-US">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>
<section id="condition">
<h2 id="hd_id3149494" xml-lang="en-US">Condition</h2>
<paragraph role="paragraph" id="par_id3143281" xml-lang="en-US"><ahelp hid="modules/swriter/ui/flddbpage/condition">For fields linked to a <link href="text/swriter/01/04090200.xhp" name="condition">condition</link>, enter the criteria here.</ahelp></paragraph>
</section>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/cond1" id="bm_id3151259" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/cond2" id="bm_id3151262" localize="false"/>
<h2 id="hd_id3151248" xml-lang="en-US">Then, Else</h2>
<paragraph role="paragraph" id="par_id3154830" xml-lang="en-US"><ahelp hid=".">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>
<paragraph role="paragraph" id="par_id3146865" xml-lang="en-US">You can also insert database fields in the <emph>Then </emph>and <emph>Else </emph>boxes using the format "databasename.tablename.fieldname".</paragraph>
<note id="par_id3147583">If the table or the field name does not exist in a database, nothing is inserted.</note>
<note id="par_id3152585">If you include the quotes in "databasename.tablename.fieldname", the expression is inserted as text.</note>
<section id="referencehelp">
<h2 id="hd_id3155136" xml-lang="en-US">Reference</h2>
<paragraph role="paragraph" id="par_id3155149" xml-lang="en-US">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>
</section>
<h2 id="hd_id3147071" xml-lang="en-US">Format<comment>UFI: see spec "Macro Selector..."</comment></h2>
<paragraph role="paragraph" id="par_id3147084" xml-lang="en-US">Select the macro that you want to run when the field is clicked.</paragraph>
<h2 id="hd_id3154384" xml-lang="en-US">Macro name</h2>
<paragraph role="paragraph" id="par_id3153351" xml-lang="en-US">Displays the name of the selected macro.</paragraph>
<h2 id="hd_id3156269" xml-lang="en-US">Placeholder</h2>
<paragraph role="paragraph" id="par_id3156282" xml-lang="en-US">Type the text that you want to appear in the placeholder field.</paragraph>
<h2 id="hd_id3150587">Hidden text</h2>
<paragraph role="paragraph" id="par_id3149173" xml-lang="en-US">Type the text that you want to hide if a condition is met.</paragraph>
<h2 id="hd_id3151028">Characters</h2>
<paragraph role="paragraph" id="par_id3145771" xml-lang="en-US">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>
<h2 id="hd_id3156369">Value</h2>
<paragraph role="paragraph" id="par_id3151370" xml-lang="en-US">Enter a value for the selected field.</paragraph>
<section id="macro">
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/macro" id="bm_id3148889" localize="false"/>
<h2 id="hd_id3148877">Macro</h2>
<paragraph role="paragraph" id="par_id3155912" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/macro">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>
</section>
<paragraph role="paragraph" id="par_id3150111" xml-lang="en-US">The following controls are displayed for <emph>Input list</emph> fields:</paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/item" id="bm_id3155871" localize="false"/>
<h2 id="hd_id3155860">Item</h2>
<paragraph role="paragraph" id="par_id3150688" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/item">Enter a new item.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/add" id="bm_id3147425" localize="false"/>
<h2 id="hd_id3147413">Add</h2>
<paragraph role="paragraph" id="par_id3147473" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/add">Adds the <emph>Item</emph> to the list.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/listitems" id="bm_id3147612" localize="false"/>
<h2 id="hd_id3147496">Items on list</h2>
<paragraph role="paragraph" id="par_id3147618" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/listitems">Lists the items. The topmost item is shown in the document.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/remove" id="bm_id3149552" localize="false"/>
<h2 id="hd_id3145263">Remove</h2>
<paragraph role="paragraph" id="par_id3149558" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/remove">Removes the selected item from the list.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/up" id="bm_id3155964" localize="false"/>
<h2 id="hd_id3145126">Move Up</h2>
<paragraph role="paragraph" id="par_id3155970" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/up">Moves the selected item up in the list.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/down" id="bm_id3150562" localize="false"/>
<h2 id="hd_id3150549">Move Down</h2>
<paragraph role="paragraph" id="par_id3156221" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/down">Moves the selected item down in the list.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldfuncpage/listname" id="bm_id3149226" localize="false"/>
<h2 id="hd_id3149215">Name</h2>
<paragraph role="paragraph" id="par_id3147733" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldfuncpage/listname">Enter a unique name for the <emph>Input list</emph>.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/dropdownfielddialog/@@nowidget@@" id="@@nowidget@@" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/dropdownfielddialog/list" id="bm_id3146344" localize="false"/>
<h2 id="hd_id3146332">Choose Item</h2>
<paragraph role="paragraph" id="par_id3147455" xml-lang="en-US">This dialog is shown when you click an <emph>Input list</emph> field in the document. </paragraph>
<paragraph role="paragraph" id="par_id3149837" xml-lang="en-US"><ahelp hid="modules/swriter/ui/dropdownfielddialog/list">Choose the item that you want to display in the document, then click <emph>OK</emph>.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/dropdownfielddialog/edit" id="bm_id3148848" localize="false"/>
<h2 id="hd_id3147602">Edit</h2>
<paragraph role="paragraph" id="par_id3148855" xml-lang="en-US"><ahelp hid="modules/swriter/ui/dropdownfielddialog/edit">Displays the <emph>Edit Fields: Functions</emph> dialog, where you can edit the <emph>Input list</emph>.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/dropdownfielddialog/next" id="bm_id3155570" localize="false"/>
<h2 id="hd_id3155558">Next</h2>
<paragraph role="paragraph" id="par_id3148434" xml-lang="en-US"><ahelp hid="modules/swriter/ui/dropdownfielddialog/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 <switchinline select="sys"><caseinline select="MAC"><keycode>Command</keycode></caseinline><defaultinline><keycode>Ctrl</keycode></defaultinline></switchinline><keycode>+Shift+F9</keycode>.</paragraph>
</body>
</helpdocument>