~ubuntu-branches/ubuntu/edgy/koffice/edgy-updates

« back to all changes in this revision

Viewing changes to kspread/extensions/reference.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ben Burton
  • Date: 2004-05-09 11:33:00 UTC
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040509113300-xi5t1z4yxe7n03x7
Tags: upstream-1.3.1
ImportĀ upstreamĀ versionĀ 1.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE KSpreadFunctions>
 
2
<KSpreadFunctions>
 
3
 
 
4
  <Group>
 
5
    <GroupName>Lookup &amp; Reference</GroupName>
 
6
 
 
7
    <Function>
 
8
      <Name>ADDRESS</Name>
 
9
      <Type>String</Type>
 
10
      <Parameter>
 
11
        <Comment>Row number</Comment>
 
12
        <Type>Int</Type>
 
13
      </Parameter>
 
14
      <Parameter>
 
15
        <Comment>Column number</Comment>
 
16
        <Type>Int</Type>
 
17
      </Parameter>
 
18
      <Parameter>
 
19
        <Comment>Absolute number (optional)</Comment>
 
20
        <Type>Int</Type>
 
21
      </Parameter>
 
22
      <Parameter>
 
23
        <Comment>A1 style (optional)</Comment>
 
24
        <Type>Boolean</Type>
 
25
      </Parameter>
 
26
      <Parameter>
 
27
        <Comment>Sheet name</Comment>
 
28
        <Type>String</Type>
 
29
      </Parameter>
 
30
      <Help>
 
31
        <Text>The ADDRESS creates a cell address. Parameter Row is the row number and Column is the column number.</Text>
 
32
        <Text>Absolute number specifies the type of reference: 1 or omitted = Absolute, 2 = Absolute row, relative column,  3 = Relative row; absolute column and 4 = Relative.</Text>
 
33
        <Text>A1 Style specifies the style of the address to return. If A1 is set to TRUE (default) the address is returned in A1 style if it is set to FALSE in R1C1 style.</Text>
 
34
        <Text>Sheet name is the text specifying the name of the sheet.</Text>
 
35
       <Syntax>ADDRESS(row; col; absolute; style; sheet name)</Syntax>
 
36
       <Example>ADDRESS(6; 4) returns $D$6</Example>
 
37
       <Example>ADDRESS(6; 4; 2) returns D$6</Example>
 
38
       <Example>ADDRESS(6; 4; 2; FALSE; "Sheet1") returns Sheet1!R6C[4]</Example>
 
39
       <Example>ADDRESS(6; 4; 1; FALSE; "Sheet1") returns Sheet1!R6C4</Example>
 
40
       <Example>ADDRESS(6; 4; 4; TRUE; "Sheet1") returns Sheet1!D6</Example>
 
41
      </Help>
 
42
     </Function>
 
43
 
 
44
    <Function>
 
45
      <Name>AREAS</Name>
 
46
      <Type>Int</Type>
 
47
      <Parameter>
 
48
        <Comment>Reference</Comment>
 
49
        <Type range="true">String</Type>
 
50
      </Parameter>
 
51
      <Help>
 
52
        <Text>Returns the number of areas in the reference string. An area can be asingle cell or a set of cells.</Text>
 
53
        <Syntax>AREAS(reference)</Syntax>
 
54
        <Example>AREAS(A1) returns 1</Example>
 
55
        <Example>AREAS((A1; A2:A4)) returns 2</Example>
 
56
      </Help>
 
57
    </Function>
 
58
 
 
59
    <Function>
 
60
      <Name>CHOOSE</Name>
 
61
      <Parameter>
 
62
        <Comment>Index</Comment>
 
63
        <Type>Int</Type>
 
64
      </Parameter>
 
65
      <Parameter>
 
66
        <Comment>Arguments</Comment>
 
67
      </Parameter>
 
68
      <Help>
 
69
        <Text>Returns the parameter specified by the index.</Text>
 
70
        <Syntax>CHOOSE(index; parameter1; parameter2;...)</Syntax>
 
71
        <Example>CHOOSE(1; "1st"; "2nd") returns "1st"</Example>
 
72
        <Example>CHOOSE(2; 3; 2; 4) returns 2</Example>
 
73
      </Help>
 
74
    </Function>
 
75
 
 
76
    <Function>
 
77
      <Name>COLUMN</Name>
 
78
      <Type>Int</Type>
 
79
      <Parameter>
 
80
        <Comment>Reference</Comment>
 
81
        <Type>String</Type>
 
82
      </Parameter>
 
83
      <Help>
 
84
        <Text>The COLUMN function returns the column of given cell reference. If no parameter is specified the column of the current cell gets returned.</Text>
 
85
        <Syntax>COLUMN(reference)</Syntax>
 
86
        <Example>COLUMN(A1) returns 1</Example>
 
87
        <Example>COLUMN(D2) returns 4</Example>
 
88
        <Related>COLUMNS</Related>
 
89
        <Related>ROW</Related>
 
90
      </Help>
 
91
    </Function>
 
92
 
 
93
    <Function>
 
94
      <Name>COLUMNS</Name>
 
95
      <Type>Int</Type>
 
96
      <Parameter>
 
97
        <Comment>Reference</Comment>
 
98
        <Type>String</Type>
 
99
      </Parameter>
 
100
      <Help>
 
101
        <Text>The COLUMNS function returns the number of columns in a reference.</Text>
 
102
        <Syntax>COLUMNS(reference)</Syntax>
 
103
        <Example>COLUMNS(A1:C3) returns 3</Example>
 
104
        <Example>COLUMNS(D2) returns 1</Example>
 
105
        <Related>COLUMN</Related>
 
106
        <Related>ROWS</Related>
 
107
      </Help>
 
108
    </Function>
 
109
 
 
110
    <Function>
 
111
      <Name>INDIRECT</Name>
 
112
      <Parameter>
 
113
        <Comment>Reference</Comment>
 
114
        <Type>String</Type>
 
115
      </Parameter>
 
116
      <Parameter>
 
117
        <Comment>A1 style (optional)</Comment>
 
118
        <Type>Boolean</Type>
 
119
      </Parameter>
 
120
      <Help>
 
121
        <Text>Returns the content of the cell specified by the reference text. The second parameter is optional.</Text>
 
122
        <Syntax>INDIRECT(referenceText, a1 style)</Syntax>
 
123
        <Example>INDIRECT(A1), A1 contains "B1", and B1 1 => returns 1</Example>
 
124
        <Example>INDIRECT("A1"), returns content of A1</Example>        
 
125
      </Help>
 
126
    </Function>
 
127
 
 
128
    <Function>
 
129
      <Name>ROW</Name>
 
130
      <Type>Int</Type>
 
131
      <Parameter>
 
132
        <Comment>Reference</Comment>
 
133
        <Type>String</Type>
 
134
      </Parameter>
 
135
      <Help>
 
136
        <Text>The ROW function returns the row of given cell reference. If no parameter is specified the row of the current cell gets returned.</Text>
 
137
        <Syntax>ROW(reference)</Syntax>
 
138
        <Example>ROW(A1) returns 1</Example>
 
139
        <Example>ROW(D2) returns 2</Example>
 
140
        <Related>ROWS</Related>
 
141
        <Related>COLUMN</Related>
 
142
      </Help>
 
143
    </Function>
 
144
 
 
145
    <Function>
 
146
      <Name>ROWS</Name>
 
147
      <Type>Int</Type>
 
148
      <Parameter>
 
149
        <Comment>Reference</Comment>
 
150
        <Type>String</Type>
 
151
      </Parameter>
 
152
      <Help>
 
153
        <Text>The ROWS function returns the number of rows in a reference.</Text>
 
154
        <Syntax>ROWS(reference)</Syntax>
 
155
        <Example>ROWS(A1:C3) returns 3</Example>
 
156
        <Example>ROWS(D2) returns 1</Example>
 
157
        <Related>ROW</Related>
 
158
        <Related>COLUMNS</Related>
 
159
      </Help>
 
160
    </Function>
 
161
 
 
162
  </Group>
 
163
 
 
164
</KSpreadFunctions>