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