1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03010304xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">QBColor Function [Runtime]</title>
28<filename>/text/sbasic/shared/03010304.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="qbcolor">
33<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>
34<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>
35</section>
36<paragraph role="heading" id="hd_id3154140" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
37<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="4">QBColor (ColorNumber As Integer)</paragraph>
38<paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
39<paragraph role="paragraph" id="par_id3154685" xml-lang="en-US" l10n="U" oldref="6">Long</paragraph>
40<paragraph role="heading" id="hd_id3156560" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
41<paragraph role="paragraph" id="par_id3161832" xml-lang="en-US" l10n="U" oldref="8">
42<emph>ColorNumber</emph>: Any integer expression that specifies the color value of the color passed from an older MS-DOS based programming system.</paragraph>
43<paragraph role="paragraph" id="par_id3147318" xml-lang="en-US" l10n="U" oldref="9">
44<emph>ColorNumber</emph> can be assigned the following values:</paragraph>
45<paragraph role="paragraph" id="par_id3152576" xml-lang="en-US" l10n="U" oldref="10">0 : Black</paragraph>
46<paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" l10n="U" oldref="11">1 : Blue</paragraph>
47<paragraph role="paragraph" id="par_id3151116" xml-lang="en-US" l10n="U" oldref="12">2 : Green</paragraph>
48<paragraph role="paragraph" id="par_id3155412" xml-lang="en-US" l10n="U" oldref="13">3 : Cyan</paragraph>
49<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="14">4 : Red</paragraph>
50<paragraph role="paragraph" id="par_id3153364" xml-lang="en-US" l10n="U" oldref="15">5 : Magenta</paragraph>
51<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="16">6 : Yellow</paragraph>
52<paragraph role="paragraph" id="par_id3154730" xml-lang="en-US" l10n="U" oldref="17">7 : White</paragraph>
53<paragraph role="paragraph" id="par_id3153877" xml-lang="en-US" l10n="U" oldref="18">8 : Gray</paragraph>
54<paragraph role="paragraph" id="par_id3147124" xml-lang="en-US" l10n="U" oldref="19">9 : Light Blue</paragraph>
55<paragraph role="paragraph" id="par_id3145646" xml-lang="en-US" l10n="U" oldref="20">10 : Light Green</paragraph>
56<paragraph role="paragraph" id="par_id3149958" xml-lang="en-US" l10n="U" oldref="21">11 : Light Cyan</paragraph>
57<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U" oldref="22">12 : Light Red</paragraph>
58<paragraph role="paragraph" id="par_id3150715" xml-lang="en-US" l10n="U" oldref="23">13 : Light Magenta</paragraph>
59<paragraph role="paragraph" id="par_id3146970" xml-lang="en-US" l10n="U" oldref="24">14 : Light Yellow</paragraph>
60<paragraph role="paragraph" id="par_id3150750" xml-lang="en-US" l10n="U" oldref="25">15 : Bright White</paragraph>
61<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>
62<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
63<embed href="text/sbasic/shared/00000003.xhp#err5"/>
64<paragraph role="heading" id="hd_id3148406" xml-lang="en-US" level="2" l10n="U" oldref="27">Example:</paragraph>
65<paragraph role="code" id="par_id3145642" xml-lang="en-US" l10n="U" oldref="28">Sub ExampleQBColor</paragraph>
66<paragraph role="code" id="par_id3154256" xml-lang="en-US" l10n="U" oldref="29">Dim iColor As Integer</paragraph>
67<paragraph role="code" id="par_id3147340" xml-lang="en-US" l10n="U" oldref="30">Dim sText As String</paragraph>
68<paragraph role="code" id="par_id3155962" xml-lang="en-US" l10n="U" oldref="31">iColor = 7</paragraph>
69<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>
70<paragraph role="code" id="par_id3149566" xml-lang="en-US" l10n="U" oldref="33">MsgBox stext,0,"Color " &amp; iColor</paragraph>
71<paragraph role="code" id="par_id3154705" xml-lang="en-US" l10n="U" oldref="34">End Sub</paragraph>
72</body>
73</helpdocument>
74