source/auxiliary/sbasic.tree | 1
source/text/sbasic/shared/03/sf_array.xhp | 1239 +++++++++++++++++--------
source/text/sbasic/shared/03/sf_dictionary.xhp | 60 -
3 files changed, 876 insertions(+), 424 deletions(-)
New commits:
commit 165f2eb082e5132ae2734c3c014bf7f35ee0ef8f
Author: Alain Romedenne <libreoffici...@sfr.fr>
AuthorDate: Mon Dec 14 16:00:33 2020 +0100
Commit: Olivier Hallot <olivier.hal...@libreoffice.org>
CommitDate: Thu Dec 17 13:53:39 2020 +0100
ScriptForge library modules - WiP
- sf_array page restored after being overwritten
- self-links in both pages on H1 tag
Change-Id: I9c3d47447124d5c7199a03c9a7d76e0e337244ef
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/107695
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org>
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree
index 6e3c33ff4..c10b8e771 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -330,6 +330,7 @@
<topic
id="sbasic/text/sbasic/shared/03/lib_importwiz.xhp">ImportWizard Library</topic>
<topic
id="sbasic/text/sbasic/shared/03/lib_schedule.xhp">Schedule Library</topic>
<topic
id="sbasic/text/sbasic/shared/03/lib_script.xhp">ScriptBindingLibrary
Library</topic>
+ <topic
id="sbasic/text/sbasic/shared/03/lib_ScriptForge.xhp">ScriptForge
Library</topic>
<topic
id="sbasic/text/sbasic/shared/03/lib_template.xhp">Template Library</topic>
<topic
id="sbasic/text/sbasic/shared/03/lib_wikieditor.xhp">WikiEditor Library</topic>
</node>
diff --git a/source/text/sbasic/shared/03/sf_array.xhp
b/source/text/sbasic/shared/03/sf_array.xhp
index d37af6f49..1824c0d20 100644
--- a/source/text/sbasic/shared/03/sf_array.xhp
+++ b/source/text/sbasic/shared/03/sf_array.xhp
@@ -8,403 +8,866 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
-->
-
<meta>
- <topic id="SF_Dictionary" indexer="include" status="PUBLISH">
- <title id="tit" xml-lang="en-US">ScriptForge.Dictionary service</title>
- <filename>/text/sbasic/shared/03/sf_dictionary.xhp</filename>
+ <topic id="SF_Array" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">ScriptForge.Array service
(SF_Array)</title>
+ <filename>/text/sbasic/shared/03/sf_array.xhp</filename>
</topic>
-</meta>
+ </meta>
<body>
-<section id="abstract">
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id261582733781987">
- <bookmark_value>Dictionary service</bookmark_value>
- <bookmark_value>API;DateTime</bookmark_value>
- <bookmark_value>API;PropertyValue</bookmark_value>
- </bookmark>
-
- <h1 id="hd_id731582733781114"
xml-lang="en-US"><literal>ScriptForge</literal>.<literal>Dictionary</literal>
service</h1>
- <paragraph role="paragraph" id="par_id891582884466217" xml-lang="en-US">A
dictionary is a collection of key-item pairs</paragraph>
- <list type="unordered">
- <listitem><paragraph id="par_id861582884516571" role="listitem"
xml-lang="en-US">The key is a case-insensitive string</paragraph></listitem>
- <listitem><paragraph id="par_id531582884549542" role="listitem"
xml-lang="en-US">Items may be of any type</paragraph></listitem>
- </list>
+<section id="abstract">
+<h1 id="bm_id781582391760253" xml-lang="en-US"><link
href="text/sbasic/shared/03/sf_array.xhp" name="ScriptForge.Array
Service"><literal>ScriptForge</literal>.<literal>Array</literal>
service</link></h1>
+ <paragraph role="paragraph" id="par_id991582454416549" xml-lang="en-US">A
collection of methods manipulating and transforming arrays of one dimension
(vectors) and arrays of two dimensions (matrices). This includes setting,
sorting, importing and exporting to csv files and Calc sheets.
+ <br/>Arrays with more than two dimensions are rejected, with the
exception of <literal>CountDims</literal> method that accepts more than two
dimensions.</paragraph>
</section>
- <paragraph role="paragraph" id="par_id891582884593057" xml-lang="en-US">Keys
and items can be retrieved, counted, updated, and much more.</paragraph>
- <paragraph role="tip" id="par_id971582884636922"
xml-lang="en-US">%PRODUCTNAME Basic <literal>Collection</literal> object does
not support the retrieval of the keys.
- <br/>Additionally its items contain only primitive Basic data types such as
dates, text, numbers, and the like.</paragraph>
-
- <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2>
-
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id851582897798335">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id371582885621964">Dim
myDict As Variant</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id201582885621287">
myDict = CreateScriptService("Dictionary")</paragraph>
- </bascode>
-
- <paragraph role="paragraph" id="par_id71158288562139" xml-lang="en-US">It is
recommended to free resources after use:</paragraph>
- <bascode>
- <paragraph role="bascode" localize="false" id="bas_id721582885621540">Set
myDict = myDict.Dispose()</paragraph>
- </bascode>
-
- <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/>
-
- <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2>
- <section id="Item">
- <table id="tab_id971582885195582">
- <tablerow>
- <tablecell>
- <paragraph id="par_id41582885195836" role="tablehead"
xml-lang="en-US">Name</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id31582885195372" role="tablehead"
xml-lang="en-US">Readonly</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id501582885895609" role="tablehead"
xml-lang="en-US">Argument</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id31582885195238" role="tablehead"
xml-lang="en-US">Type</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id931582885195131" role="tablehead"
xml-lang="en-US" >Description</paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id97158288519551" role="tablecontent"
localize="false">Count</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id221582885195686" role="tablecontent"
xml-lang="en-US">Yes</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id851582885948589" role="tablecontent"
localize="false"></paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id371582885195525" role="tablecontent"
localize="false">Long</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id881582885195976" role="tablecontent"
xml-lang="en-US">The actual number of entries in the dictionary</paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id7715828856553" role="tablecontent"
localize="false">Item</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id861582885655779" role="tablecontent"
xml-lang="en-US">Yes</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id621582885990445" role="tablecontent"
localize="false">Key As String</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id271582885655525" role="tablecontent"
localize="false">Variant</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id581582885655885" role="tablecontent"
xml-lang="en-US">The value of the item related to <literal>Key</literal><br
/><literal>Empty</literal> if not found</paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id841582886030384" role="tablecontent"
localize="false">Items</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id441582886030118" role="tablecontent"
xml-lang="en-US">Yes</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id411582886030478" role="tablecontent"
localize="false"></paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id131582886030297" role="tablecontent"
xml-lang="en-US">Array of Variants</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id471582886030489" role="tablecontent"
xml-lang="en-US">The list of items as a one dimension array</paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id231582886791351" role="tablecontent"
localize="false">Keys</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id971582886791838" role="tablecontent"
xml-lang="en-US">Yes</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id721582886791467" role="tablecontent"
localize="false"></paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id271582886791111" role="tablecontent"
xml-lang="en-US">Array of Strings</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id16158288679167" role="tablecontent"
xml-lang="en-US">The list of keys as a one dimension array</paragraph>
- </tablecell>
- </tablerow>
- </table>
- </section>
-
- <paragraph role="tip" id="par_id461582886731495" xml-lang="en-US">The Keys
and Items properties return their respective contents, using an identical
ordering.
- <br/>The order is unrelated to the creation sequence.</paragraph>
-
- <h3 id="hd_id691582887572811" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false" id="bas_id211582887012398">Dim
a As Variant, b As String</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id351582887179042">
a = myDict.Keys</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id251582887187534">
For Each b In a</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id121582887198799">
' ...</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id571606473148931">
Next b</paragraph>
- </bascode>
-
- <table id="tab_id891606472825856">
- <tablerow>
- <tablecell><paragraph id="par_id581606472825856" role="tablehead"
localize="false"></paragraph></tablecell>
- <tablecell><paragraph id="par_id921606472825856"
role="tablehead">Methods</paragraph></tablecell>
- <tablecell><paragraph id="par_id781606472825856" role="tablehead"
localize="false"></paragraph></tablecell>
- </tablerow>
- <tablerow>
- <tablecell><paragraph id="par_id381606472825856" role="tablecontent">
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#Add" name="Add
method">Add</link><br/><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToArray"
name="ConvertToArray method">ConvertToArray</link><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToJson"
name="ConvertToJson method">ConvertToJson</link><br/>
- <link
href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToPropertyValues"
name="ConvertToPropertyValues method">ConvertToPropertyValues</link>
- </paragraph></tablecell>
- <tablecell><paragraph id="par_id451606472825856" role="tablecontent">
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#Exists"
name="Exists method">Exists</link><br/><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#ImportFromJson"
name="ImportFromJson method">ImportFromJson</link><br/>
- <link
href="text/sbasic/shared/03/sf_dictionary.xhp#ImportFromPropertyValues"
name="ImportFromPropertyValues method">ImportFromPropertyValues</link><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#Item"
name="Item method">Item</link>
- </paragraph></tablecell>
- <tablecell><paragraph id="par_id161606472825856" role="tablecontent">
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#Remove"
name="Remove method">Remove</link><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#RemoveAll"
name="RemoveAll method">RemoveAll</link><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#ReplaceItem"
name="ReplaceItem method">ReplaceItem</link><br/>
- <link href="text/sbasic/shared/03/sf_dictionary.xhp#ReplaceKey"
name="ReplaceKey method">ReplaceKey</link>
- </paragraph></tablecell>
- </tablerow>
- </table>
+ <paragraph role="paragraph" id="par_id651582454426538"
xml-lang="en-US">Array items may contain any type of value, including
(sub)arrays.</paragraph>
- <section id="Add">
- <comment> Add
--------------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id781582887670029">
- <bookmark_value>Dictionary service;Add</bookmark_value>
- </bookmark>
- <h2 id="hd_id831582887670029" localize="false">Add</h2>
- <paragraph role="paragraph" id="par_id831582887670029">Add a new
key-item pair into the dictionary. Returns <literal>True</literal> if
successful.</paragraph>
- <h3 id="hd_id451582887670029" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id731582887670029">myDict.Add(Key As String, Item As Variant) As
Boolean</paragraph>
- </bascode>
- <h3 id="hd_id821582887670030" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph"
id="par_id341582887670030"><emph>Key</emph> : Not case-sensitive. Must not yet
exist in the dictionary, otherwise a <literal>DUPLICATEKEYERROR</literal> error
is generated. Spaces only generate a <literal>INVALIDKEYERROR</literal>
error.</paragraph>
- <paragraph role="paragraph"
id="par_id401582887670030"><emph>Item</emph> : Any value, including an array, a
Basic object, a UNO object, a dictionary, ...</paragraph>
- <h3 id="hd_id461582887670030" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id191582887670030">Dim NewValue As Variant</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id391582887670030"> myDict.Add("NewKey", NewValue)</paragraph>
- </bascode>
- </section>
+ <h2 id="hd_id981586595097630" xml-lang="en-US">Service invocation</h2>
+ <paragraph role="paragraph" id="par_id63158659509728" xml-lang="en-US">Next
code snippets are equivalent (<literal>Append</literal> is used as example)
:</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id871608192694632">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id311586595097510">SF_Array.Append(...)</paragraph>
+ </bascode>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id811586595097328">Dim arr : arr = SF_Array</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id761586595097825">arr.Append(...)</paragraph>
+ </bascode>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id821586595097892">Dim arr : arr =
CreateScriptService("Array")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id81586595097173">arr.Append(...)</paragraph>
+ </bascode>
- <section id="ConvertToArray">
- <comment> ConvertToArray
--------------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id621582888424103">
- <bookmark_value>Dictionary service;ConvertToArray</bookmark_value>
- </bookmark>
- <h2 id="hd_id211582888424104" localize="false">ConvertToArray</h2>
- <paragraph role="paragraph" id="par_id81582888424104">Store the
content of the dictionary in a two-columns zero-based array. The key is stored
in the first column, the item is stored in the second column.
- <br />The resulting array is empty when the dictionary is
empty.</paragraph>
- <h3 id="hd_id201582888424104" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id251582888424105">myDict.ConvertToArray() As Variant</paragraph>
- </bascode>
- </section>
-
- <section id="ConvertToJson">
- <comment> ConvertToJson
---------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id631601296836318">
- <bookmark_value>Dictionary service;ConvertToJson</bookmark_value>
- </bookmark>
- <h2 id="hd_id851601296836224" localize="false">ConvertToJson</h2>
- <paragraph role="paragraph" id="par_id831601296836981">Convert the
content of the dictionary to <link href="https://en.wikipedia.org/wiki/JSON";
name="JSON text">JSON (JavaScript Object Notation)</link> text.</paragraph>
- <h3 id="hd_id261601297024828" xml-lang="en-US">Limitations</h3>
- <paragraph role="paragraph" id="par_id401601297178073"
xml-lang="en-US">Allowed data types are: <literal>String</literal>,
<literal>Boolean</literal>, numbers, <literal>Null</literal> and
<literal>Empty</literal>. Arrays containing items of those types are allowed,
whatever their dimensions. Dates are converted into strings but not within
arrays where they are forbidden. Other data types are converted to their string
representation (cfr. SF_String.Represent).</paragraph>
- <h3 id="hd_id551601296836572" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id491601296836271">myDict.ConvertToJson([Indent As Variant]) As
String</paragraph>
- </bascode>
- <h3 id="hd_id1001601296836123" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph" id="par_id8816012968362"><emph>Indent</emph>
: When <literal>Indent</literal> is a positive number or a text, JSON array
elements and object members are pretty-printed with that indent level. A
negative <literal>Indent</literal> value solely insert new lines.
<literal>Indent</literal> default value "" selects the most compact
representation. Using a positive integer for <literal>Indent</literal> indents
that many spaces per level. When <literal>Indent</literal> is a string, such as
<literal>Chr(9)</literal> or <literal>Tab(1)</literal>, the tab sign is used to
indent each level.</paragraph>
- <h3 id="hd_id19160129683665" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id671601298281962">myDict.Add("p0", 12.5)</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id851601298288784">myDict.Add("p1", "a string àé""ê")</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id201601298295976">myDict.Add("p2", DateSerial(2020,9,28))</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id951601298323286">myDict.Add("p3", True)</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id731601298329491">myDict.Add("p4", Array(1,2,3))</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id451601298336500">MsgBox a.ConvertToJson() ' {"p0": 12.5, "p1":
"a string \u00e0\u00e9\"\u00ea", "p2": "2020-09-28", "p3": true, "p4": [1, 2,
3]}</paragraph>
- </bascode>
- </section>
-
- <section id="ConvertToPropertyValues">
- <comment> ConvertToPropertyValues
-----------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id991582889470402">
- <bookmark_value>Dictionary
service;ConvertToPropertyValues</bookmark_value>
- </bookmark>
- <h2 id="hd_id421582889470909"
localize="false">ConvertToPropertyValues</h2>
- <paragraph role="paragraph" id="par_id151582889470596">Store the
content of the dictionary in an array of <literal>PropertyValues</literal>.
- <br />Each entry in the array is a
<literal>com.sun.star.beans.PropertyValue</literal>. The key is stored in
<literal>Name</literal>, the item is stored in <literal>Value</literal>.
- <br />If one of the items has a type <literal>Date</literal>, it is
converted to a <literal>com.sun.star.util.DateTime</literal> structure.
- <br />If one of the items is an empty array, it is converted to
<literal>Null</literal>.
- <br />The resulting array is empty when the dictionary is
empty.</paragraph>
- <h3 id="hd_id841582889470464" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id191582889470444">myDict.ConvertToPropertyValues() As
Variant</paragraph>
- </bascode>
- </section>
-
- <section id="Exists">
- <comment> Exists
--------------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id81582889812915">
- <bookmark_value>Dictionary service;Exists</bookmark_value>
- </bookmark>
- <h2 id="hd_id461582889812915" localize="false">Exists</h2>
- <paragraph role="paragraph" id="par_id841582889812916">Determine if a
key exists in the dictionary.</paragraph>
- <h3 id="hd_id601582889812916" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id311582889812917">myDict.Exists(Key As String) As Boolean</paragraph>
- </bascode>
- <h3 id="hd_id661582889812917" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph"
id="par_id971582889812917"><emph>Key</emph> : The key to check.</paragraph>
- <h3 id="hd_id231582889812918" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id741582889812919">If Not myDict.Exists("newkey") Then</paragraph>
- <paragraph role="bascode" id="bas_id471582889812919"> ' You may
add it safely to the dictionary</paragraph>
- <paragraph role="bascode"
id="bas_id811606485130666">EndIf</paragraph>
- </bascode>
- </section>
-
- <section id="ImportFromJson">
- <comment> ImportFromJson
---------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id661601391980619">
- <bookmark_value>Dictionary service;ImportFromJson</bookmark_value>
- </bookmark>
- <h2 id="hd_id81601391980848" localize="false">ImportFromJson</h2>
- <paragraph role="paragraph" id="par_id791601391980978">Add the content
of a <link href="https://en.wikipedia.org/wiki/JSON"; name="JSON text">JSON
(JavaScript Object Notation)</link> text into the current dictionary. Returns
<literal>True</literal> if successful.</paragraph>
- <h3 id="hd_id961601392113644" xml-lang="en-US">Limitations</h3>
- <paragraph role="paragraph" id="par_id481601392181131"
xml-lang="en-US">The JSON string may contain numbers, text, booleans, null
values and arrays containing those types. It must not contain JSON objects
namely sub-dictionaries.</paragraph>
- <paragraph role="paragraph" id="par_id511601392205908"
xml-lang="en-US">An attempt is made to convert text to date if the item fits
one of these patterns: YYYY-MM-DD, HH:MM:SS or YYYY-MM-DD HH:MM:SS.</paragraph>
- <h3 id="hd_id301601391980982" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id401601391980113">myDict.ImportFromJson(InputStr As String, [Overwrite
As Boolean]) As Boolean</paragraph>
- </bascode>
- <h3 id="hd_id871601391980130" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph"
id="par_id69160139198061"><emph>InputStr</emph> : The string to
import.</paragraph>
- <paragraph role="paragraph"
id="par_id201601391980268"><emph>Overwrite</emph> : when
<literal>True</literal>, entries with same name may exist in the dictionary and
their values are overwritten. When <literal>False</literal> (default), synonyms
raise an error. Note that dictionary keys are not case-sensitive while names
are case-sensitive in JSON strings.</paragraph>
- <h3 id="hd_id141601391980338" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id411601393205207">Dim s As String</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id891601393212562"> s = "{'firstName': 'John','lastName':
'Smith','isAlive': true,'age': 66, 'birth': '1954-09-28 20:15:00'"
_</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id221601393220997"> & ",'address': {'streetAddress': '21 2nd
Street','city': 'New York','state': 'NY','postalCode': '10021-3100'}"
_</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id931601393226582"> & ",'phoneNumbers': [{'type':
'home','number': '212 555-1234'},{'type': 'office','number': '646 555-4567'}]"
_</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id671601393233042"> & ",'children':
['Q','M','G','T'],'spouse': null}"</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id131601393240390"> s = Replace(s, "'", """")</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id351601393248554"> myDict.ImportFromJson(s, OverWrite :=
True)</paragraph>
- <paragraph role="bascode" id="bas_id521601393254694"> '
The (sub)-dictionaries "address" and "phoneNumbers(0) and (1) are reduced to
Empty.</paragraph>
- </bascode>
- </section>
-
- <section id="ImportFromPropertyValues">
- <comment> ImportFromPropertyValues
---------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id791588941968651">
- <bookmark_value>Dictionary
service;ImportFromPropertyValues</bookmark_value>
- </bookmark>
- <h2 id="hd_id71588941968955"
localize="false">ImportFromPropertyValues</h2>
- <paragraph role="paragraph" id="par_id651588941968228">Insert the
content of an array of <literal>PropertyValues</literal> into the current
dictionary. Names contain the new keys, values contain the new items. Returns
<literal>True</literal> if successful.</paragraph>
- <h3 id="hd_id82158894196854" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id961588941968180">myDict.ImportFromPropertyValues(PropertyValues As
Variant [, Overwrite As Boolean]) As Boolean</paragraph>
- </bascode>
- <h3 id="hd_id271588941968528" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph"
id="par_id751588941968522"><emph>PropertyValues</emph> : a zero-based 1
dimension array. Each entry is a UNO object of type
<literal>com.sun.star.beans.PropertyValue</literal>. The argument may also be a
single item.</paragraph>
- <paragraph role="paragraph"
id="par_id21588941968131"><emph>Overwrite</emph> : when
<literal>True</literal>, entries with same name may exist in the dictionary and
their values are overwritten. When <literal>False</literal> (default), synonyms
raise an error. Note that dictionary keys are not case-sensitive while names
are case-sensitive in sets of property values.</paragraph>
- <h3 id="hd_id501588941968965" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id951588941968987">Dim vProp As New
com.sun.star.beans.PropertyValue</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id831588943409828"> vProp.Name = "prop" : vProp.Value =
CDateToUnoDateTime(Now)</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id771588941968883"> myDict.ImportFromPropertyValues(vProp, Overwrite
:= True)</paragraph>
- </bascode>
- </section>
-
- <section id="Remove">
- <comment> Remove
--------------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id741582890366762">
- <bookmark_value>Dictionary service;Remove</bookmark_value>
- </bookmark>
- <h2 id="hd_id301582890366573" localize="false">Remove</h2>
- <paragraph role="paragraph" id="par_id891582890366737">Remove an
existing dictionary entry based on its key. Returns <literal>True</literal> if
successful.</paragraph>
- <h3 id="hd_id731582890366531" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id71582890366664">myDict.Remove(Key As String) As Boolean</paragraph>
- </bascode>
- <h3 id="hd_id771582890366698" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph"
id="par_id551582890366999"><emph>Key</emph> : Not case-sensitive. Must exist in
the dictionary, otherwise a <literal>UNKNOWNKEYERROR</literal> error is
generated.</paragraph>
- <h3 id="hd_id81582890366375" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id371582890366702">myDict.Remove("OldKey")</paragraph>
- </bascode>
- </section>
-
- <section id="RemoveAll">
- <comment> RemoveAll
--------------------------------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id471582896275914">
- <bookmark_value>Dictionary service;RemoveAll</bookmark_value>
- </bookmark>
- <h2 id="hd_id911582896275637" localize="false">RemoveAll</h2>
- <paragraph role="paragraph" id="par_id921582896275624">Remove all the
entries from the dictionary. Returns <literal>True</literal> if
successful.</paragraph>
- <h3 id="hd_id161582896275448" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
- <bascode>
- <paragraph role="bascode" localize="false"
id="bas_id56158289627581">myDict.RemoveAll() As Boolean</paragraph>
- </bascode>
- </section>
+ <table id="tab_id221606235233835">
+ <tablerow>
+ <tablecell colspan="3"><paragraph id="par_id651606319520519"
role="tablehead">Methods</paragraph></tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell><paragraph id="par_id361606235233835" role="tablecontent"
localize="false">
+ <link href="text/sbasic/shared/03/sf_array.xhp#Append" name="Append
method">Append</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#AppendColumn"
name="AppendColumn method">AppendColumn</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#AppendRow"
name="AppendRow method">AppendRow</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Contains" name="Contains
method">Contains</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#ConvertToDictionary"
name="ConvertToDictionary method">ConvertToDictionary</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#CountDims"
name="CountDims method">CountDims</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Difference"
name="Difference method">Difference</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#ExportToTextFile"
name="ExportToTextFile method">ExportToTextFile</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#ExtractColumn"
name="ExtractColumn">ExtractColumn</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#ExtractRow"
name="ExtractRow method">ExtractRow</link>
+ </paragraph></tablecell>
+ <tablecell><paragraph id="par_id231606235233835" role="tablecontent"
localize="false">
+ <link href="text/sbasic/shared/03/sf_array.xhp#Flatten" name="Flatten
method">Flatten</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#ImportFromCSVFile"
name="ImportFromCSVFile method">ImportFromCSVFile</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#IndexOf" name="IndexOf
method">IndexOf</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Insert" name="Insert
method">Insert</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#InsertSorted"
name="InsertSorted method">InsertSorted</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Intersection"
name="Intersection">Intersection</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Join2D" name="Join2D
method">Join2D</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Prepend" name="Prepend
method">Prepend</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#PrependColumn"
name="PrependColumn method">PrependColumn</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#PrependRow"
name="PrependRow method">PrependRow</link><br/>
+ </paragraph></tablecell>
+ <tablecell><paragraph id="par_id831606235233835" role="tablecontent"
localize="false">
+ <link href="text/sbasic/shared/03/sf_array.xhp#RangeInit"
name="RangeInit method">RangeInit</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Reverse" name="Reverse
method">Reverse</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Shuffle" name="Shuffle
method">Shuffle</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Slice" name="Slice
method">Slice</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Sort" name="Sort
method">Sort</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#SortColumns"
name="SortColumns method">SortColumns</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#SortRows"
name="SortRows method">SortRows</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Transpose"
name="Transpose method">Transpose</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#TrimArray"
name="TrimArray method">TrimArray</link><br/><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Union" name="Union
method">Union</link><br/>
+ <link href="text/sbasic/shared/03/sf_array.xhp#Unique" name="Unique
method">Unique</link><br/>
+ </paragraph></tablecell>
+ </tablerow>
+ </table>
+ <tip id="par_id191582454485250" xml-lang="en-US">The first argument of most
methods is the array to consider. It is always passed by reference and left
unchanged.</tip>
+ <section id="Append">
+ <comment> Append
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id251582548992953">
+ <bookmark_value>Array service;Append</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id151582548992953" localize="false">Append</h2>
+ <paragraph role="paragraph" id="par_id931582548992953">Append at the end of
the input array the items listed as arguments.</paragraph>
+ <h3 id="hd_id71582548992953" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id681582548992953">SF_Array.Append(Array_1D As Variant, arg0 As
Variant, [arg1 As Variant], ...) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id631582548992953" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id471582548992953"><emph>Array_1D</emph> : the pre-existing array, may
be empty.</paragraph>
+ <paragraph role="paragraph" id="par_id531582548992953"><emph>arg0,
...</emph> : a list of items to append to Array_1D.</paragraph>
+ <h3 id="hd_id301582548992954" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id11582548992954">Sub
Example_Append()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id101582548992954">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id561582548992954">
a = SF_Array.Append(Array(1, 2, 3), 4, 5)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id541582548992954">
' (1, 2, 3, 4, 5)</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id331582548992954">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="AppendColumn">
+ <comment> AppendColumn
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id591582549679172">
+ <bookmark_value>Array service;AppendColumn</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id291582549679173" localize="false">AppendColumn</h2>
+ <paragraph role="paragraph" id="par_id241582549679173">Append to the right
side of a two dimension array a new column. The resulting array has the same
lower bounds as the initial two dimension array.</paragraph>
+ <h3 id="hd_id81582549679174" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id901582549679174">SF_Array.AppendColumn(Array_2D As Variant, Column As
Variant) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id41582549679175" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id461582549679175"><emph>Array_2D</emph> : the pre-existing array, may
be empty. If that array has 1 dimension, it is considered as the first column
of the resulting 2 dimension array.</paragraph>
+ <paragraph role="paragraph"
id="par_id991582549679175"><emph>Column</emph> : a 1 dimension array with as
many items as there are rows in <literal>Array_2D</literal>.</paragraph>
+ <h3 id="hd_id961582549679176" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id461582549679176">Sub Example_AppendColumn()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id341582549679177">Dim a As Variant, b As variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id681582549679177">
a = SF_Array.AppendColumn(Array(1, 2, 3), Array(4, 5, 6))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id151582549679177">
' ((1, 4), (2, 5), (3, 6))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id961582550242823">
b = SF_Array.AppendColumn(Array(), Array(1, 2, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id381582550413514">
' ∀ i ∈ {0 ≤ i ≤ 2} : b(0, i) ≡ i</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id141582549679178">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="AppendRow">
+ <comment> AppendRow
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id451582551311490">
+ <bookmark_value>Array service;AppendRow</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id751582551333335" localize="false">AppendRow</h2>
+ <paragraph role="paragraph" id="par_id941582551396374">Append to the bottom
of a two dimension array a new row. The resulting array has the same lower
bounds as the initial two dimension array.</paragraph>
+ <h3 id="hd_id731582551411476" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id721582551425203">SF_Array.AppendRow(Array_2D As Variant, Row As
Variant) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id391582551448394" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id631582551461984"><emph>Array_2D</emph> : the pre-existing array, may
be empty. If that array has 1 dimension, it is considered as the first row of
the resulting 2 dimension array.</paragraph>
+ <paragraph role="paragraph" id="par_id101582551483685"><emph>Row</emph> : a
1D array with as many items as there are columns in Array_2D.</paragraph>
+ <h3 id="hd_id501582551510428" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id241582551522761">Sub Example_AppendRow()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id521582551530025">Dim a As Variant, b As variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id951582551538465">
a = SF_Array.AppendRow(Array(1, 2, 3), Array(4, 5, 6))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id521582551545445">
' ((1, 2, 3), (4, 5, 6))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id431582551552206">
b = SF_Array..AppendRow(Array(), Array(1, 2, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id851582551572028">
' ∀ i ∈ {0 ≤ i ≤ 2} : b(i, 0) ≡ i</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id371582551580870">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Contains">
+ <comment> Contains
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id521582552517869">
+ <bookmark_value>Array service;Contains</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id21582552517870" localize="false">Contains</h2>
+ <paragraph role="paragraph" id="par_id391582552517870">Check if a one
dimension array contains a certain number, text or date. Text comparison can be
case-sensitive or not.
+ <br/>Sorted input arrays must be filled homogeneously, meaning all items
must be scalars of the same type (<literal>Empty</literal> and
<literal>Null</literal> items are forbidden).
+ <br/>The result of the method is unpredictable when the array is
announced as sorted and is in reality not.
+ <br/>A binary search is done when the array is sorted, otherwise, it is
simply scanned from top to bottom and <literal>Empty</literal> and
<literal>Null</literal> items are ignored.</paragraph>
+ <h3 id="hd_id571582552517870" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id511582552517871">SF_Array.Contains(Array_1D, ToFind As Variant,
[CaseSensitive As Boolean], [SortOrder As String]) As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id771582552517871" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id451582552517871"><emph>Array_1D</emph> : the array to
scan.</paragraph>
+ <paragraph role="paragraph" id="par_id221582552517872"><emph>ToFind</emph>
: a number, a date or a string to find.</paragraph>
+ <paragraph role="paragraph"
id="par_id981582552517872"><emph>CaseSensitive</emph> : Only for string
comparisons, default = <literal>False</literal>.</paragraph>
+ <paragraph role="paragraph"
id="par_id641582553128490"><emph>SortOrder</emph> : "ASC", "DESC" or "" (= not
sorted, default)</paragraph>
+ <h3 id="hd_id921582552517872" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id641582552517872">Sub Example_Contains()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id651582552517872">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id111582552517872">
a = SF_Array.Contains(Array("A","B","c","D"), "C", SortOrder := "ASC") '
True</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id681582552517872">
SF_Array.Contains(Array("A","B","c","D"), "C", CaseSensitive := True) '
False</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id91582552517872">End
Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="ConvertToDictionary">
+ <comment> ConvertToDictionary
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id441582557214489">
+ <bookmark_value>Array service;ConvertToDictionary</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id541582557214489" localize="false">ConvertToDictionary</h2>
+ <paragraph role="paragraph" id="par_id71582557214489">Store the content
of a 2-columns array into a <literal>ScriptForge</literal> <link
href="text/text/sbasic/shared/03/sf_dictionary.xhp)"
name="dictionary">Dictionary</link> object.
+ <br/>The key will be extracted from the first column, the item from the
second.</paragraph>
+ <h3 id="hd_id481582557214489" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id921582557214489">SF_Array.ConvertToDictionary(Array_2D As Variant) As
Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id761582557214489" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id561582557214489"><emph>Array_1D</emph> : the first column must
contain exclusively strings with a length > 0, in any order.</paragraph>
+ <h3 id="hd_id591582557214490" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id851582557214490">Sub Example_ConvertToDictionary()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id921582557214490">Dim a As Variant, b As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id261582557214490">
a = SF_Array.AppendColumn(Array("a", "b", "c"), Array(1, 2, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id931582557802907">
b = SF_Array.ConvertToDictionary(a)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id421582557214490">
MsgBox b.Item("c") ' 3</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id731582557214490">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="CountDims">
+ <comment> CountDims
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id251582558126024">
+ <bookmark_value>Array service;CountDims</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id761582558126025" localize="false">CountDims</h2>
+ <paragraph role="paragraph" id="par_id671582558126025">Count the number of
dimensions of an array. The result can be greater than two.
+ <br/>If the argument is not an array, returns -1
+ <br/>If the array is not initialized, returns 0.</paragraph>
+ <h3 id="hd_id611582558126025" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id211582558126026">SF_Array.CountDims(Array_ND As Variant) As
Integer</paragraph>
+ </bascode>
+ <h3 id="hd_id51582558126026" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id771582558126027"><emph>Array_ND</emph> : the array to
examine.</paragraph>
+ <h3 id="hd_id611582558126028" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id931582558126028">Sub Example_CountDims()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id661582558126028">Dim a(1 To 10, -3 To 12, 5)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id291582558126028">
MsgBox SF_Array.CountDims(a) ' 3</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id871582558126028">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Difference">
+ <comment> Difference
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id941582558644286">
+ <bookmark_value>Array service;Difference</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id21582558644287" localize="false">Difference</h2>
+ <paragraph role="paragraph" id="par_id91582558644287">Build a set, as a
zero-based array, by applying the difference operator on the two input arrays.
Resulting items originate from the first array and not from the second.
+ <br/>The resulting array is sorted in ascending order.
+ <br/>Both input arrays must be filled homogeneously, their items must be
scalars of the same type. <literal>Empty</literal> and <literal>Null</literal>
items are forbidden.
+ <br/>Text comparison can be case sensitive or not.</paragraph>
+ <h3 id="hd_id441582558644287" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id491582558644287">SF_Array.Difference(Array1_1D As Variant, Array2_1D
As Variant[, CaseSensitive As Boolean]) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id641582558644287" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id271582558644287"><emph>Array1_1D</emph> : A 1 dimension reference
array, whose items are examined for removal.</paragraph>
+ <paragraph role="paragraph"
id="par_id141582558644287"><emph>Array2_1D</emph> : A 1 dimension array, whose
items are subtracted from the first input array.</paragraph>
+ <paragraph role="paragraph"
id="par_id291582559651473"><emph>CaseSensitive</emph> : Only if the arrays are
populated with strings, default = <literal>False</literal>.</paragraph>
+ <h3 id="hd_id811582558644287" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id151582558644288">Sub Example_Difference()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id141582558644288">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id971582560754091">
a = SF_Array.Difference(Array("A", "C", "A", "b", "B"), Array("C", "Z", "b"),
True)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id281582560766794">
' ("A", "B")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id871582558644288">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="ExportToTextFile">
+ <comment> ExportToTextFile
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_iid101582629162107">
+ <bookmark_value>Array service;ExportToTextFile</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id231586179707778" localize="false">ExportToTextFile</h2>
+ <paragraph role="paragraph" id="par_id941586179707156">Write all items of
the array sequentially to a text file. If the file exists already, it will be
overwritten without warning.</paragraph>
+ <h3 id="hd_id831586179707159" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id54158617970786">SF_Array.ExportToTextFile(Array_1D As Variant,
FileName As String, [Encoding As String]) As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id44158617970749" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id100158617970719"><emph>Array_1D</emph> : The array to export. It must
contain only strings.</paragraph>
+ <paragraph role="paragraph"
id="par_id101586179707232"><emph>FileName</emph> : the name of the text file
containing the data. The name is expressed as given by the current
<literal>FileNaming</literal> property of the <literal>SF_FileSystem</literal>
service. Default = any (both the URL format and the native operating system
format are admitted).</paragraph>
+ <paragraph role="paragraph" id="par_id70158617970791"
xml-lang="en-US"><emph>Encoding</emph> : The character set that should be used.
Use one of the names listed in <link
href="https://www.iana.org/assignments/character-sets/character-sets.xhtml";
name="IANA character sets">IANA character sets</link>. Note that %PRODUCTNAME
may not implement all existing character sets. Default is "UTF-8".</paragraph>
+ <h3 id="hd_id281586179707112" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id831586179707765">Sub Example_ExportToTextFile()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id551586179707687">
SF_Array.ExportToTextFile(Array("A","B","C","D"), "C:\Temp\A short
file.txt")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id241586179707813">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="ExtractToColumn">
+ <comment> ExtractColumn
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id891582560281081">
+ <bookmark_value>Array service;ExtractColumn</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id721582560281081" localize="false">ExtractColumn</h2>
+ <paragraph role="paragraph" id="par_id171582560281082">Extract from a two
dimension array a specific column as a new array.
+ <br/>Its lower <literal>LBound</literal> and upper
<literal>UBound</literal> boundaries are identical to that of the first
dimension of the input array.</paragraph>
+ <h3 id="hd_id341582560281082" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id821582560281083">SF_Array.ExtractColumn(Array_2D As Variant,
ColumnIndex As Long) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id841582560281083" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id301582560281083"><emph>Array_2D</emph> : The array from which to
extract.</paragraph>
+ <paragraph role="paragraph"
id="par_id421582560281084"><emph>ColumnIndex</emph> : The column number to
extract - must be in the interval <literal>[LBound,
UBound]</literal>.</paragraph>
+ <h3 id="hd_id111582560281085" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id821582560281085">-
|1, 2, 3|</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id831582560741676">-
SF_Array.ExtractColumn(|4, 5, 6|, 2) ' (3, 6, 9)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id661582560281085">-
|7, 8, 9|</paragraph>
+ </bascode>
+ </section>
+ <section id="ExtractRow">
+ <comment> ExtractRow
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id891582561395261">
+ <bookmark_value>Array service;ExtractRow</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id921582561457245" localize="false">ExtractRow</h2>
+ <paragraph role="paragraph" id="par_id211582561467219">Extract from a two
dimension array a specific row as a new array.
+ <br/>Its lower <literal>LBound</literal> and upper
<literal>UBound</literal> boundaries are identical to that of the second
dimension of the input array.</paragraph>
+ <h3 id="hd_id271582561491472" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id531582561508949">SF_Array.ExtractRow(Array_2D As Variant, RowIndex As
Long) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id151582561525826" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id911582561542889"><emph>Array_2D</emph> : The array from which to
extract.</paragraph>
+ <paragraph role="paragraph"
id="par_id441582561551202"><emph>RowIndex</emph> : The row number to extract -
must be in the interval <literal>[LBound, UBound]</literal>.</paragraph>
+ <h3 id="hd_id891582561576040" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id941582561596912">-
|1, 2, 3|</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id301582561604167">-
SF_Array.ExtractRow(|4, 5, 6|, 2) ' (7, 8, 9)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id100158256161206">-
|7, 8, 9|</paragraph>
+ </bascode>
+ </section>
+ <section id="Flatten">
+ <comment> Flatten
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id261585757822682">
+ <bookmark_value>Array service;Flatten</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id351585757822637" localize="false">Flatten</h2>
+ <paragraph role="paragraph" id="par_id431585757822181">Stack all single
items of an array and all items in its subarrays into one new array without
subarrays. Empty subarrays are ignored and subarrays with a number of
dimensions greater than one are not flattened.</paragraph>
+ <h3 id="hd_id861585757822848" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id61585757822431">SF_Array.Flatten(Array_1D As Variant) As
Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id231585757822628" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id431585757822869"><emph>Array_1D</emph> : the pre-existing array, may
be empty.</paragraph>
+ <h3 id="hd_id70158575782242" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id721585757822109">Sub Example_Flatten()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id231585757822493">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id131585757822885">
a = SF_Array.Flatten(Array(Array(1, 2, 3), 4, 5))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id631585757822119">
' (1, 2, 3, 4, 5)</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id141585757822713">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="ImportFromCSVFile">
+ <comment> ImportFromCSVFile
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_iid101582629162107">
+ <bookmark_value>Array service;ImportFromCSVFile</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id581585561482142" localize="false">ImportFromCSVFile</h2>
+ <paragraph role="paragraph" id="par_id611585561482373">Import the data
contained in a comma-separated values (CSV) file. The comma may be replaced by
any character.</paragraph>
+ <paragraph role="paragraph" id="par_id41585562158392" xml-lang="en-US">The
applicable CSV format is described in <link
href="https://tools.ietf.org/html/rfc4180"; name="CSV formats">IETF Common
Format and MIME Type for CSV Files</link>.</paragraph>
+ <paragraph role="paragraph" id="par_id641585562341028"
xml-lang="en-US">Each line in the file contains a full record (line splitting
is not allowed).
+ <br/>However sequences like <literal>\n</literal>, <literal>\t</literal>,
... are left unchanged. Use <literal>SF_String</literal>.Unescape() method to
manage them.</paragraph>
+ <paragraph role="paragraph" id="par_id231585562475026" xml-lang="en-US">The
method returns a two dimension array whose rows correspond to a single record
read in the file and whose columns correspond to a field of the record. No
check is made about the coherence of the field types across columns. A best
guess will be made to identify numeric and date types.</paragraph>
+ <paragraph role="paragraph" id="par_id101585562548245" xml-lang="en-US">If
a line contains less or more fields than the first line in the file, an
exception will be raised. Empty lines however are simply ignored. If the size
of the file exceeds the number of items limit (see inside the code), a warning
is raised and the array is truncated.</paragraph>
+ <h3 id="hd_id171585561482793" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id351585561482418">SF_Array.ImportFromCSVFile(FileName As String,
[Delimiter As String], [DateFormat As String]) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id461585561482379" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id441585561482121"><emph>FileName</emph> : the name of the text file
containing the data. The name is expressed as given by the current
<literal>FileNaming</literal> property of the <literal>SF_FileSystem</literal>
service. Default = any (both the URL format and the native operating system
format are admitted).</paragraph>
+ <paragraph role="paragraph"
id="par_id251585561482929"><emph>Delimiter</emph> : A single character,
usually, a comma, a semicolon or a TAB character. Default =
<literal>","</literal>.</paragraph>
+ <paragraph role="paragraph" id="par_id631585563491559"
xml-lang="en-US"><emph>DateFormat</emph> : A special mechanism handles dates
when <literal>DateFormat</literal> is either "YYYY-MM-DD", "DD-MM-YYYY" or
"MM-DD-YYYY". The dash (-) may be replaced by a dot (.), a slash (/) or a
space. Other date formats will be ignored. Dates defaulting to "" are
considered as normal text.</paragraph>
+ <h3 id="hd_id52158556148278" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <paragraph role="paragraph" id="par_id61585564516409"
xml-lang="en-US">Given this CSV file:</paragraph>
+ <bascode>
+ <paragraph role="bascode" xml-lang="en-US"
id="bas_id891585564144231">Name,DateOfBirth,Address,City</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id761585564150479">Anna,2002/03/31,"Rue de l'église,
21",Toulouse</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id911585564157141">Fred,1998/05/04,"Rue Albert Einstein,
113A",Carcassonne</paragraph>
+ </bascode>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id321585561482696">Sub Example_ImportFromCSVFile()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id391585561482567">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id531585561482408">
a = SF_Array.ImportFromCSVFile("C:\Temp\myFile.csv", DateFormat :=
"YYYY/MM/DD")</paragraph>
+ <paragraph role="bascode" xml-lang="en-US" id="bas_id621585561482783">
MsgBox a(0, 3) ' City</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id21585564425349">
MsgBox TypeName(a(1, 2)) ' Date</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id831585564433851">
MsgBox a(2, 2) ' Rue Albert Einstein, 113A</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id591585561482616">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="IndexOf">
+ <comment> IndexOf
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id361582562709465">
+ <bookmark_value>Array service;IndexOf</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id741582562715741" localize="false">IndexOf</h2>
+ <paragraph role="paragraph" id="par_id211582562721860">Look in a one
dimension array for a number, a string or a date. Text comparison can be
case-sensitive or not.
+ <br/>If the array is sorted it must be filled homogeneously, which means
that all items must be scalars of the same type (<literal>Empty</literal> and
<literal>Null</literal> items are forbidden).
+ <br/>The result of the method is unpredictable when the array is
announced as sorted and actually is not.
+ <br/>A binary search is performed on sorted arrays. Otherwise, arrays
are simply scanned from top to bottom and <literal>Empty</literal> and
<literal>Null</literal> items are ignored.
+ <br/>
+ <br/>The method returns <literal>LBound(input array) - 1</literal> if
the search was not successful.</paragraph>
+ <h3 id="hd_id901582562736452" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id251582562747218">SF_Array.IndexOf(Array_1D, ToFind As Variant,
[CaseSensitive As Boolean], [SortOrder As String]) As Long</paragraph>
+ </bascode>
+ <h3 id="hd_id11582562760632" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id315825627687760"><emph>Array_1D</emph> : the array to
scan.</paragraph>
+ <paragraph role="paragraph" id="par_id511582562775516"><emph>ToFind</emph>
: a number, a date or a string to find.</paragraph>
+ <paragraph role="paragraph"
id="par_id311582562787187"><emph>CaseSensitive</emph> : Only for string
comparisons, default = <literal>False</literal>.</paragraph>
+ <paragraph role="paragraph"
id="par_id421582562794501"><emph>SortOrder</emph> : <literal>"ASC"</literal>,
<literal>"DESC"</literal> or <literal>""</literal> (= not sorted,
default)</paragraph>
+ <h3 id="hd_id121582562803122" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id471582562909129">Sub Example_IndexOf()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id291582562917140">
MsgBox SF_Array.IndexOf(Array("A","B","c","D"), "C", SortOrder := "ASC") '
2</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id100158256292397">
MsgBox SF_Array.IndexOf(Array("A","B","c","D"), "C", CaseSensitive := True) '
-1</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id641582562955330">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Insert">
+ <comment> Insert
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id371582626951108">
+ <bookmark_value>Array service;Insert</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id101582626951109" localize="false">Insert</h2>
+ <paragraph role="paragraph" id="par_id911582626951109">Insert before a
given index of the input array the items listed as arguments.
+ <br/>Arguments are inserted blindly. Each of them might be either a
scalar of any type or a subarray.</paragraph>
+ <h3 id="hd_id811582626951110" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id821582626951110">SF_Array.Insert(Array_1D As Variant, Before As Long,
arg0 As Variant, [arg1 As Variant], ...) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id111582626951110" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id251582626951111"><emph>Array_1D</emph> : the pre-existing array, may
be empty.</paragraph>
+ <paragraph role="paragraph" id="par_id361582626951111"><emph>Before</emph>
: the index before which to insert; must be in the interval <literal>[LBound,
UBound + 1]</literal>.</paragraph>
+ <paragraph role="paragraph" id="par_id41582626951111"><emph>arg0,
...</emph> : a list of items to insert inside
<literal>Array_1D</literal>.</paragraph>
+ <h3 id="hd_id401582626951112" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id701582626951112">Sub Example_Insert()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id11582626951112">Dim
a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id231582626951113">
a = SF_Array.Insert(Array(1, 2, 3), 2, "a", "b")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id841582626951113">
' (1, 2, "a", "b", 3)</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id341582626951114">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="InsertSorted">
+ <comment> InsertSorted
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id311582627664147">
+ <bookmark_value>Array service;InsertSorted</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id981582627664147" localize="false">InsertSorted</h2>
+ <paragraph role="paragraph" id="par_id441582627664147">Insert in a sorted
array a new item on its place.
+ <br/>The array must be filled homogeneously, meaning that all items must
be scalars of the same type.
+ <br/><literal>Empty</literal> and <literal>Null</literal> items are
forbidden.</paragraph>
+ <h3 id="hd_id621582627664147" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id61582627664147">SF_Array.InsertSorted(Array_1D As Variant, Item As
Variant, SortOrder As String, CaseSensitive As Boolean) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id941582627664147" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id121582627664147"><emph>Array_1D</emph> : The array to
sort.</paragraph>
+ <paragraph role="paragraph" id="par_id315826276641480"><emph>Item</emph> :
The scalar value to insert, of the same type as the existing array
items.</paragraph>
+ <paragraph role="paragraph"
id="par_id415826279771170"><emph>SortOrder</emph> : <literal>"ASC"</literal>
(default) or <literal>"DESC"</literal>.</paragraph>
+ <paragraph role="paragraph"
id="par_id701582627970037"><emph>CaseSensitive</emph> : Only for string
comparisons, default = <literal>False</literal>.</paragraph>
+ <h3 id="hd_id461582627664148" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id261582627664148">Sub Example_InsertSorted()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id91582627664148">Dim
a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id31582627664148">
a = SF_Array.InsertSorted(Array("A", "C", "a", "b"), "B", CaseSensitive :=
True)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id831582627664148">
' ("A", "B", "C", "a", "b")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id591582627664148">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Intersection">
+ <comment> Intersection
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_iid101582629162107">
+ <bookmark_value>Array service;Intersection</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id841582629169550" localize="false">Intersection</h2>
+ <paragraph role="paragraph" id="par_id71582629177169">Build a set, as a
zero-based array, by applying the intersection set operator on the two input
arrays. Resulting items are contained in both arrays.
+ <br/>The resulting array is sorted in ascending order.
+ <br/>Both input arrays must be filled homogeneously, in other words all
items must be scalars of the same type. <literal>Empty</literal> and
<literal>Null</literal> items are forbidden.
+ <br/>Text comparison can be case sensitive or not.</paragraph>
+ <h3 id="hd_id681582629188055" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id731582629197251">SF_Array.Intersection(Array1_1D As Variant,
Array2_1D As Variant[, CaseSensitive As Boolean]) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id431582629205750" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id881582629216169"><emph>Array1_1D</emph> : The first input
array.</paragraph>
+ <paragraph role="paragraph"
id="par_id191582629223038"><emph>Array2_1D</emph> : The second input
array.</paragraph>
+ <paragraph role="paragraph"
id="par_id71582629230275"><emph>CaseSensitive</emph> : Applies to arrays
populated with text items, default = <literal>False</literal>.</paragraph>
+ <h3 id="hd_id871582629239015" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id391582629249730">Sub Example_Intersection()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id331582629257228">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id811582629266094">
a = SF_Array.Intersection(Array("A", "C", "A", "b", "B"), Array("C", "Z",
"b"), True)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id171582629275916">
' ("C", "b")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id561582629284117">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Join2D">
+ <comment> Join2D
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id231583064481294">
+ <bookmark_value>Array service;Join2D</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id641583064481282" localize="false">Join2D</h2>
+ <paragraph role="paragraph" id="par_id431583064481679">Join a
two-dimensional array with two delimiters, one for the columns, one for the
rows.</paragraph>
+ <h3 id="hd_id51158306448110" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id151583064481767">SF_Array.Join2D(Array_2D As Variant, ColumnDelimiter
As String, RowDelimiter As String, Quote As Boolean) As String</paragraph>
+ </bascode>
+ <h3 id="hd_id131583064481226" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id821583064481534"><emph>Array_2D</emph> : Each item must be either
text, a number, a date or a boolean.
+ <br/>Dates are transformed into the YYYY-MM-DD hh:mm:ss format.
+ <br/>Invalid items are replaced by a zero-length string.</paragraph>
+ <paragraph role="paragraph" id="par_id171583066989446"
xml-lang="en-US"><emph>ColumnDelimiter</emph> : Delimits each column (default =
Tab/Chr(9)).</paragraph>
+ <paragraph role="paragraph" id="par_id431583067008842"
xml-lang="en-US"><emph>RowDelimiter</emph>: delimits each row (default =
LineFeed/Chr(10))</paragraph>
+ <paragraph role="paragraph" id="par_id541583067456273"
xml-lang="en-US"><emph>Quote</emph> : if <literal>True</literal>, protect
strings with double quotes. The default is <literal>False</literal>.</paragraph>
+ <h3 id="hd_id24158306448125" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id991583064481860">Sub Example_Join2D()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id981583064481420">-
| 1, 2, "A", [2020-02-29], 5 |</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id881583064481455">-
SF_Array.Join_2D(| 6, 7, "this is a string", 9, 10 |, ",", "/")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id515830644818749">-
' "1,2,A,2020-02-29 00:00:00,5/6,7,this is a string,9,10"</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id891583064481120">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Prepend">
+ <comment> Prepend
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id701582629972724">
+ <bookmark_value>Array service;Prepend</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id931582629986047" localize="false">Prepend</h2>
+ <paragraph role="paragraph" id="par_id731582630075045">Prepend at the
beginning of the input array the items listed as arguments.</paragraph>
+ <h3 id="hd_id11582630082029" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id401582630090649">SF_Array.Prepend(Array_1D As Variant, arg0 As
Variant, [arg1 As Variant], ...) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id961582630099102" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id321582630107068"><emph>Array_1D</emph> : the pre-existing array, may
be empty.</paragraph>
+ <paragraph role="paragraph" id="par_id915826301138550"><emph>arg0,
...</emph> : a list of items to prepend to
<literal>Array_1D</literal>.</paragraph>
+ <h3 id="hd_id431582630183499" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id711582630125376">Sub Example_Prepend()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id321582630131988">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id851582630138380">
a = SF_Array.Prepend(Array(1, 2, 3), 4, 5)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id681582630144971">
' (4, 5, 1, 2, 3)</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id441582630151256">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="PrependColumn">
+ <comment> PrependColumn
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id211582643223924">
+ <bookmark_value>Array service;PrependColumn</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id25158264322311" localize="false">PrependColumn</h2>
+ <paragraph role="paragraph" id="par_id91582643223166">Prepend to the left
side of a two dimension array a new column. The resulting array has the same
lower boundaries as the initial two dimension array.</paragraph>
+ <h3 id="hd_id391582643223553" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id981582643223807">SF_Array.PrependColumn(Array_2D As Variant, Column
As Variant) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id321582643223125" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id621582643223545"><emph>Array_2D</emph> : the pre-existing array, may
be empty. If that array has 1 dimension, it is considered as the last column of
the resulting 2 dimension array.</paragraph>
+ <paragraph role="paragraph" id="par_id381582643223870"><emph>Column</emph>
: a 1 dimension array with as many items as there are rows in
<literal>Array_2D</literal>.</paragraph>
+ <h3 id="hd_id6158264322351" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id781582643223405">Sub Example_PrependColumn()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id601582643223931">Dim a As Variant, b As variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id28158264322323">
a = SF_Array.PrependColumn(Array(1, 2, 3), Array(4, 5, 6))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id901582643223295">
' ((4, 1), (5, 2), (6, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id361582643223747">
b = SF_Array.PrependColumn(Array(), Array(1, 2, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id821582643223417">
' ∀ i ∈ {0 ≤ i ≤ 2} : b(0, i) ≡ i</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id351582643223716">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="PrependRow">
+ <comment> PrependRow
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id321582643611165">
+ <bookmark_value>Array service;PrependRow</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id921582643611272" localize="false">PrependRow</h2>
+ <paragraph role="paragraph" id="par_id851582643611291">Prepend at the
beginning of a two dimension array a new row. The resulting array has the same
lower boundaries as the initial two dimension array.</paragraph>
+ <h3 id="hd_id211582643611828" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id841582643611957">SF_Array.PrependRow(Array_2D As Variant, Row As
Variant) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id391582643611919" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id991582643611645"><emph>Array_2D</emph> : the pre-existing array, may
be empty. If that array has 1 dimension, it is considered as the last row of
the resulting 2 dimension array.</paragraph>
+ <paragraph role="paragraph" id="par_id321582643611415"><emph>Row</emph> : a
1 dimension array containing as many items as there are rows in
<literal>Array_2D</literal>.</paragraph>
+ <h3 id="hd_id811582643611644" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id471582643611765">Sub Example_PrependRow()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id611582643611408">Dim a As Variant, b As variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id941582643611530">
a = SF_Array.PrependRow(Array(1, 2, 3), Array(4, 5, 6))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id621582643611876">
' ((4, 5, 6), (1, 2, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id791582643611123">
b = SF_Array.PrependRow(Array(), Array(1, 2, 3))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id621582643611263">
' ∀ i ∈ {0 ≤ i ≤ 2} : b(i, 0) ≡ i</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id201582643611274">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="RangeInit">
+ <comment> RangeInit
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id321582648204011">
+ <bookmark_value>Array service;RangeInit</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id61582648204011" localize="false">RangeInit</h2>
+ <paragraph role="paragraph" id="par_id441582648204012">Initialize a new
zero-based array with numeric values.</paragraph>
+ <h3 id="hd_id921582648204012" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id121582648204012">SF_Array.RangeInit(From As [number], UpTo As
[number] [, ByStep As [number]]) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id541582648204013" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id591582648204013"><emph>From</emph> :
value of the first item.</paragraph>
+ <paragraph role="paragraph" id="par_id31582648204013"><emph>UpTo</emph> :
The last item should not exceed <literal>UpTo</literal>.</paragraph>
+ <paragraph role="paragraph" id="par_id581582648204014"><emph>ByStep</emph>
: The difference between two successive items (default = 1).</paragraph>
+ <h3 id="hd_id791582648204014" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id851582648204014">Sub Example_RangeInit()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id341582648204015">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id901582648204015">
a = SF_Array.RangeInit(10, 1, -1)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id171582648204015">
' (10, 9, 8, 7, 6, 5, 4, 3, 2, 1)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id71582648204016">End
Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Reverse">
+ <comment> Reverse
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id31582648806764">
+ <bookmark_value>Array service;Reverse</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id111582648806764" localize="false">Reverse</h2>
+ <paragraph role="paragraph" id="par_id451582648806764">Return the reversed
one dimension input array.</paragraph>
+ <h3 id="hd_id711582648806764" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id81582648806764">SF_Array.Reverse(Array_1D As Variant) As
Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id101582648806765" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id31582648806765"><emph>Array_1D</emph>
: The array to reverse.</paragraph>
+ <h3 id="hd_id109582648806765" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id771582648806765">Sub Example_Reverse()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id251582648806765">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id31582648806765">
a = SF_Array.Reverse(Array("a", 2, 3, 4))</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id431582648806765">
' (4, 3, 2, "a")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id1001582648806765">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Shuffle">
+ <comment> Shuffle
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id531582649200087">
+ <bookmark_value>Array service;Shuffle</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id731582649200088" localize="false">Shuffle</h2>
+ <paragraph role="paragraph" id="par_id151582649200088">Return a random
permutation of a one dimension array.</paragraph>
+ <h3 id="hd_id161582649200088" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id851582649200088">SF_Array.Shuffle(Array_1D As Variant) As
Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id471582649200088" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id11582649200088"><emph>Array_1D</emph>
: The array to shuffle.</paragraph>
+ <h3 id="hd_id61582649200088" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id541582649200088">Sub Example_Shuffle()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id561582649200088">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id831582649200088">
a = SF_Array.Shuffle(Array(1, 2, 3, 4))</paragraph>
+ <paragraph role="bascode" id="bas_id611582649200089"> '
Unpredictable</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id231582649200089">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Slice">
+ <comment> Slice
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id20158618418514">
+ <bookmark_value>Array service;Slice</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id281586184185623" localize="false">Slice</h2>
+ <paragraph role="paragraph" id="par_id111586184185502">Return a subset of a
one dimension array.</paragraph>
+ <h3 id="hd_id451586184185454" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id221586184185613">SF_Array.Slice(Array_1D As Variant, From As Long,
[UpTo As Long]) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id731586184185764" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id201586184185438"><emph>Array_1D</emph> : The array to
slice.</paragraph>
+ <paragraph role="paragraph" id="par_id921586184482370"
xml-lang="en-US"><emph>From</emph> : The lower index in
<literal>Array_1D</literal> of the subarray to extract (<literal>From</literal>
included)</paragraph>
+ <paragraph role="paragraph" id="par_id211586184471488"
xml-lang="en-US"><emph>UpTo</emph> : The upper index in
<literal>Array_1D</literal> of the subarray to extract (<literal>UpTo</literal>
included). Default = upper bound of <literal>Array_1D</literal>. If
<literal>UpTo</literal> < <literal>From</literal> then the returned array is
empty.</paragraph>
+ <h3 id="hd_id691586184185665" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id90158618418541">Sub
Example_Slice()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id951586184185679">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id151586184185884">
a = SF_Array.Slice(Array(1, 2, 3, 4, 5), 1, 3) ' (2, 3, 4)</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id681586184185203">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="Sort">
+ <comment> Sort
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id561582649483854">
+ <bookmark_value>Array service;Sort</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id65158264948384" localize="false">Sort</h2>
+ <paragraph role="paragraph" id="par_id171582649483675">Sort a one dimension
array in ascending or descending order. Text comparisons can be case-sensitive
or not.
+ <br/>The array must be filled homogeneously, which means that items must
be scalars of the same type.
+ <br/><literal>Empty</literal> and <literal>Null</literal> items are
allowed. Conventionally <literal>Empty</literal> < <literal>Null</literal>
< any other scalar value.</paragraph>
+ <h3 id="hd_id111582649483962" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id341582649483281">SF_Array.Sort(Array_1D As Variant, SortOrder As
String, CaseSensitive As Boolean) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id911582649483582" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id71158264948346"><emph>Array_1D</emph>
: The array to sort.</paragraph>
+ <paragraph role="paragraph"
id="par_id21582649483175"><emph>SortOrder</emph> : <literal>"ASC"</literal>
(default) or <literal>"DESC"</literal>.</paragraph>
+ <paragraph role="paragraph"
id="par_id301582649483187"><emph>CaseSensitive</emph> : Only for string
comparisons, default = <literal>False</literal>.</paragraph>
+ <h3 id="hd_id94158264948315" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id81582649483649">Sub
Example_Sort()</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id661582649483468">Dim a As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id391582649483752">
a = SF_Array.Sort(Array("a", "A", "b", "B", "C"), CaseSensitive :=
True)</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id711582649483987">
' ("A", "B", "C", "a", "b")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id131582649483610">End Sub</paragraph>
+ </bascode>
+ </section>
+ <section id="SortColumns">
+ <comment> SortColumns
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id51582650186361">
+ <bookmark_value>Array service;SortColumns</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id20158265018616" localize="false">SortColumns</h2>
+ <paragraph role="paragraph" id="par_id801582650186957">Return a permutation
of the columns of a two dimension array, sorted on the values of a given row.
+ <br/>The row must be filled homogeneously, which means that all items
must be scalars of the same type.
+ <br/><literal>Empty</literal> and <literal>Null</literal> items are
allowed. Conventionally <literal>Empty</literal> < <literal>Null</literal>
< any other scalar value.</paragraph>
+ <h3 id="hd_id551582650186211" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id351582650186630">SF_Array.SortColumns(Array_1D As Variant, RowIndex
As Long, SortOrder As String, CaseSensitive As Boolean) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id521582650186884" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id921582650186869"><emph>Array_1D</emph> : The array to
sort.</paragraph>
+ <paragraph role="paragraph"
id="par_id311582650186221"><emph>RowIndex</emph> : The index of the row to sort
the columns on.</paragraph>
+ <paragraph role="paragraph"
id="par_id34158265018698"><emph>SortOrder</emph> : <literal>"ASC"</literal>
(default) or <literal>"DESC"</literal>.</paragraph>
+ <paragraph role="paragraph"
id="par_id91158265018699"><emph>CaseSensitive</emph> : Only for string
comparisons, default = <literal>False</literal>.</paragraph>
+ <h3 id="hd_id191582650186178" localize="false"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id561582650186620">Sub Example_SortColumns()</paragraph>
... etc. - the rest is truncated
_______________________________________________
Libreoffice-commits mailing list
libreoffice-comm...@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
