helpcontent2/source/text/sbasic/shared/03010304.xhp

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3
   4 <!--***********************************************************************
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * Copyright 2008 by Sun Microsystems, Inc.
   9  *
  10  * OpenOffice.org - a multi-platform office productivity suite
  11  *
  12  * $RCSfile: 03010304.xhp,v $
  13  * $Revision: 1.5 $
  14  *
  15  * This file is part of OpenOffice.org.
  16  *
  17  * OpenOffice.org is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Lesser General Public License version 3
  19  * only, as published by the Free Software Foundation.
  20  *
  21  * OpenOffice.org is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Lesser General Public License version 3 for more details
  25  * (a copy is included in the LICENSE file that accompanied this code).
  26  *
  27  * You should have received a copy of the GNU Lesser General Public License
  28  * version 3 along with OpenOffice.org.  If not, see
  29  * <http://www.openoffice.org/license.html>
  30  * for a copy of the LGPLv3 License.
  31  *
  32  ************************************************************************-->
  33
  34 <helpdocument version="1.0">
  35 <meta>
  36 <topic id="textsbasicshared03010304xml" indexer="include" status="PUBLISH">
  37 <title id="tit" xml-lang="en-US">QBColor Function [Runtime]</title>
  38 <filename>/text/sbasic/shared/03010304.xhp</filename>
  39 </topic>
  40 <history>
  41 <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
  42 <lastedited date="2004-09-01T15:17:50">converted from old format - fpe</lastedited>
  43 </history>
  44 </meta>
  45 <body>
  46 <section id="qbcolor">
  47 <paragraph role="heading" id="hd_id3149670" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03010304.xhp" name="QBColor Function [Runtime]">QBColor Function [Runtime]</link></paragraph>
  48 <paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="2">Returns the <link href="text/sbasic/shared/03010305.xhp" name="RGB">RGB</link> color code of the color passed as a color value through an older MS-DOS based programming system.</paragraph>
  49 </section>
  50 <paragraph role="heading" id="hd_id3154140" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
  51 <paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="4">QBColor (ColorNumber As Integer)</paragraph>
  52 <paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
  53 <paragraph role="paragraph" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="6">Long</paragraph>
  54 <paragraph role="heading" id="hd_id3156560" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
  55 <paragraph role="paragraph" id="par_id3161832" xml-lang="en-US" l10n="U" oldref="8">
  56 <emph>ColorNumber</emph>: Any integer expression that specifies the color value of the color passed from an older MS-DOS based programming system.</paragraph>
  57 <paragraph role="paragraph" id="par_id3147318" xml-lang="en-US" l10n="U" oldref="9">
  58 <emph>ColorNumber</emph> can be assigned the following values:</paragraph>
  59 <paragraph role="paragraph" id="par_id3152576" xml-lang="en-US" l10n="U" oldref="10">0 : Black</paragraph>
  60 <paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" l10n="U" oldref="11">1 : Blue</paragraph>
  61 <paragraph role="paragraph" id="par_id3151116" xml-lang="en-US" l10n="U" oldref="12">2 : Green</paragraph>
  62 <paragraph role="paragraph" id="par_id3155412" xml-lang="en-US" l10n="U" oldref="13">3 : Cyan</paragraph>
  63 <paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="14">4 : Red</paragraph>
  64 <paragraph role="paragraph" id="par_id3153364" xml-lang="en-US" l10n="U" oldref="15">5 : Magenta</paragraph>
  65 <paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="16">6 : Yellow</paragraph>
  66 <paragraph role="paragraph" id="par_id3154730" xml-lang="en-US" l10n="U" oldref="17">7 : White</paragraph>
  67 <paragraph role="paragraph" id="par_id3153877" xml-lang="en-US" l10n="U" oldref="18">8 : Gray</paragraph>
  68 <paragraph role="paragraph" id="par_id3147124" xml-lang="en-US" l10n="U" oldref="19">9 : Light Blue</paragraph>
  69 <paragraph role="paragraph" id="par_id3145646" xml-lang="en-US" l10n="U" oldref="20">10 : Light Green</paragraph>
  70 <paragraph role="paragraph" id="par_id3149958" xml-lang="en-US" l10n="U" oldref="21">11 : Light Cyan</paragraph>
  71 <paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U" oldref="22">12 : Light Red</paragraph>
  72 <paragraph role="paragraph" id="par_id3150715" xml-lang="en-US" l10n="U" oldref="23">13 : Light Magenta</paragraph>
  73 <paragraph role="paragraph" id="par_id3146970" xml-lang="en-US" l10n="U" oldref="24">14 : Light Yellow</paragraph>
  74 <paragraph role="paragraph" id="par_id3150750" xml-lang="en-US" l10n="U" oldref="25">15 : Bright White</paragraph>
  75 <paragraph role="paragraph" id="par_id3146914" xml-lang="en-US" l10n="U" oldref="26">This function is used only to convert from older MS-DOS based BASIC applications that use the above color codes. The function returns a long integer value indicating the color to be used in the $[officename] IDE.</paragraph>
  76 <embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
  77 <embed href="text/sbasic/shared/00000003.xhp#err5"/>
  78 <paragraph role="heading" id="hd_id3148406" xml-lang="en-US" level="2" l10n="U" oldref="27">Example:</paragraph>
  79 <paragraph role="code" id="par_id3145642" xml-lang="en-US" l10n="U" oldref="28">Sub ExampleQBColor</paragraph>
  80 <paragraph role="code" id="par_id3154256" xml-lang="en-US" l10n="U" oldref="29">Dim iColor As Integer</paragraph>
  81 <paragraph role="code" id="par_id3147340" xml-lang="en-US" l10n="U" oldref="30">Dim sText As String</paragraph>
  82 <paragraph role="code" id="par_id3155962" xml-lang="en-US" l10n="U" oldref="31">iColor = 7</paragraph>
  83 <paragraph role="code" id="par_id3145230" xml-lang="en-US" l10n="U" oldref="32">sText = "RGB= " &amp; Red(QBColor( iColor) ) &amp; ":" &amp; Blue(QBColor( iColor) ) &amp; ":" &amp; Green(QBColor( iColor) )</paragraph>
  84 <paragraph role="code" id="par_id3149566" xml-lang="en-US" l10n="U" oldref="33">MsgBox stext,0,"Color " &amp; iColor</paragraph>
  85 <paragraph role="code" id="par_id3154705" xml-lang="en-US" l10n="U" oldref="34">End Sub</paragraph>
  86 </body>
  87 </helpdocument>