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