blob: 6b7dd777309fab8e35eabd7b00686c47af6a117d [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
***********************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03010304xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">QBColor Function [Runtime]</title>
<filename>/text/sbasic/shared/03010304.xhp</filename>
</topic>
</meta>
<body>
<section id="qbcolor">
<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>
<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>
</section>
<paragraph role="heading" id="hd_id3154140" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U">QBColor (ColorNumber As Integer)</paragraph>
<paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3154685" xml-lang="en-US" l10n="U">Long</paragraph>
<paragraph role="heading" id="hd_id3156560" xml-lang="en-US" level="2" l10n="U">Parameter:</paragraph>
<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>
<paragraph role="paragraph" id="par_id3147318" xml-lang="en-US" l10n="U"><emph>ColorNumber</emph> can be assigned the following values:</paragraph>
<paragraph role="paragraph" id="par_id3152576" xml-lang="en-US" l10n="U">0 : Black</paragraph>
<paragraph role="paragraph" id="par_id3146975" xml-lang="en-US" l10n="U">1 : Blue</paragraph>
<paragraph role="paragraph" id="par_id3151116" xml-lang="en-US" l10n="U">2 : Green</paragraph>
<paragraph role="paragraph" id="par_id3155412" xml-lang="en-US" l10n="U">3 : Cyan</paragraph>
<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U">4 : Red</paragraph>
<paragraph role="paragraph" id="par_id3153364" xml-lang="en-US" l10n="U">5 : Magenta</paragraph>
<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U">6 : Yellow</paragraph>
<paragraph role="paragraph" id="par_id3154730" xml-lang="en-US" l10n="U">7 : White</paragraph>
<paragraph role="paragraph" id="par_id3153877" xml-lang="en-US" l10n="U">8 : Gray</paragraph>
<paragraph role="paragraph" id="par_id3147124" xml-lang="en-US" l10n="U">9 : Light Blue</paragraph>
<paragraph role="paragraph" id="par_id3145646" xml-lang="en-US" l10n="U">10 : Light Green</paragraph>
<paragraph role="paragraph" id="par_id3149958" xml-lang="en-US" l10n="U">11 : Light Cyan</paragraph>
<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U">12 : Light Red</paragraph>
<paragraph role="paragraph" id="par_id3150715" xml-lang="en-US" l10n="U">13 : Light Magenta</paragraph>
<paragraph role="paragraph" id="par_id3146970" xml-lang="en-US" l10n="U">14 : Light Yellow</paragraph>
<paragraph role="paragraph" id="par_id3150750" xml-lang="en-US" l10n="U">15 : Bright White</paragraph>
<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>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph role="heading" id="hd_id3148406" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
<paragraph role="code" id="par_id3145642" xml-lang="en-US" l10n="U">Sub ExampleQBColor</paragraph>
<paragraph role="code" id="par_id3154256" xml-lang="en-US" l10n="U">Dim iColor As Integer</paragraph>
<paragraph role="code" id="par_id3147340" xml-lang="en-US" l10n="U">Dim sText As String</paragraph>
<paragraph role="code" id="par_id3155962" xml-lang="en-US" l10n="U">iColor = 7</paragraph>
<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>
<paragraph role="code" id="par_id3149566" xml-lang="en-US" l10n="U">MsgBox stext,0,"Color " &amp; iColor</paragraph>
<paragraph role="code" id="par_id3154705" xml-lang="en-US" l10n="U">End Sub</paragraph>
</body>
</helpdocument>