diff options
| author | Rafael Lima <rafael.palma.lima@gmail.com> | 2021-10-06 16:17:39 +0200 |
|---|---|---|
| committer | Rafael Lima <rafael.palma.lima@gmail.com> | 2021-10-07 19:37:03 +0200 |
| commit | 82e70eb6efa88c3d21606292a042cd6978385480 (patch) | |
| tree | 668ef78a3ce141c78d9dc6922745bd888b6535f1 /source/text/sbasic/shared/03102800.xhp | |
| parent | 163eaf2bf056073232a1336632e11e535c8a3000 (diff) | |
tdf#143687 Document the "IS" Basic keyword
This patch also improves related help pages about the functions IsObject and EqualUnoObjects.
Change-Id: I5f16596ed057c1104d5fa2650299861741bd7b2e
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/123153
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romedenne@libreoffice.org>
Diffstat (limited to 'source/text/sbasic/shared/03102800.xhp')
| -rw-r--r-- | source/text/sbasic/shared/03102800.xhp | 60 |
1 files changed, 32 insertions, 28 deletions
diff --git a/source/text/sbasic/shared/03102800.xhp b/source/text/sbasic/shared/03102800.xhp index 650992598e..4655ee47f6 100644 --- a/source/text/sbasic/shared/03102800.xhp +++ b/source/text/sbasic/shared/03102800.xhp @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> <!-- * This file is part of the LibreOffice project. * @@ -16,35 +17,25 @@ * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . --> -<helpdocument version="1.0"> + <meta> -<topic id="textsbasicshared03102800xml" indexer="include" status="PUBLISH"> -<title id="tit" xml-lang="en-US">IsObject Function</title> -<filename>/text/sbasic/shared/03102800.xhp</filename> -</topic> -<history> -<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> -</history> + <topic id="textsbasicshared03102800xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsObject Function</title> + <filename>/text/sbasic/shared/03102800.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> </meta> <body> -<section id="isobject"> -<bookmark xml-lang="en-US" branch="index" id="bm_id3149346"><bookmark_value>IsObject function</bookmark_value> -</bookmark> -<paragraph role="heading" id="hd_id3149346" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03102800.xhp" name="IsObject Function">IsObject Function</link></paragraph> -<paragraph role="paragraph" id="par_id3148538" xml-lang="en-US">Tests if a variable is an object, as opposed to primitive data types such as dates, numbers, texts. The function returns <literal>True</literal> if the variable is an object, otherwise it returns <literal>False</literal>.</paragraph> -</section> -<paragraph role="heading" id="hd_id3149234" xml-lang="en-US" level="2">Syntax:</paragraph> -<bascode> -<paragraph role="bascode" id="par_id3154285" xml-lang="en-US">IsObject(var)</paragraph> -</bascode> -<paragraph role="heading" id="hd_id3148685" xml-lang="en-US" level="2">Return value:</paragraph> -<paragraph role="paragraph" id="par_id3156024" xml-lang="en-US">Boolean</paragraph> -<paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="2">Parameters:</paragraph> -<paragraph role="paragraph" id="par_id3148552" xml-lang="en-US"> -<emph>var:</emph> Any variable that you want to test.</paragraph> -<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> -<embed href="text/sbasic/shared/00000003.xhp#err5"/> -<paragraph role="paragraph" id="par_id891575896963115">The following objects return <literal>True</literal>:</paragraph> + <section id="isobject"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark_value>IsObject function</bookmark_value> + </bookmark> + <h1 id="hd_id51633474369322"><variable id="IsObject_h1"><link href="text/sbasic/shared/03102800.xhp" name="IsObject Function">IsObject Function</link></variable></h1> + <paragraph role="paragraph" id="par_id3148538" xml-lang="en-US">Tests if a variable is an object, as opposed to primitive data types such as dates, numbers, texts. The function returns <literal>True</literal> if the variable is an object, otherwise it returns <literal>False</literal>.</paragraph> + </section> + <paragraph role="paragraph" id="par_id891575896963115">This function returns <literal>True</literal> for the following object types:</paragraph> <list type="unordered"> <listitem><paragraph id="par_id471575892220352" role="listitem"><switchinline select="sys"><caseinline select="WIN">OLE objects or </caseinline></switchinline>UNO objects</paragraph></listitem> <listitem><paragraph id="par_id451575892264518" role="listitem"><link href="text/sbasic/shared/classmodule.xhp" name="Class module">Class module</link> object instances</paragraph></listitem> @@ -53,8 +44,21 @@ <listitem><paragraph id="par_id511575889156356" role="listitem">%PRODUCTNAME Basic modules</paragraph></listitem> </list> <warning id="par_id441575886284392">Data structures return <literal>True</literal> even when empty. Object defined variables return <literal>True</literal> even if uninitialized.</warning> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id331633474506248"> + <input>IsObject(var)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id3156024" xml-lang="en-US">Boolean</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id3148552" xml-lang="en-US"> + <emph>var:</emph> The variable to be tested.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <section id="relatedtopics"> - <paragraph role="paragraph" id="par_id191575887649871"><link href="text/sbasic/shared/enum.xhp" name="Enum statement">Enum statement</link></paragraph> + <embed href="text/sbasic/shared/03104600.xhp#EqualUnoObjects_h1"/> + <paragraph role="paragraph" id="par_id191575887649871"><link href="text/sbasic/shared/enum.xhp" name="Enum statement">Enum statement</link></paragraph> <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> <!-- Function statement--> <!-- Object type--> @@ -65,4 +69,4 @@ <paragraph role="paragraph" id="par_id811575887627196"><link href="text/sbasic/shared/01020100.xhp" name="Using variables">Using variables</link></paragraph> </section> </body> -</helpdocument>
\ No newline at end of file +</helpdocument> |