81 lines
4.6 KiB
XML
81 lines
4.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<helpdocument version="1.0">
|
|
<!--
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* 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 .
|
|
-->
|
|
|
|
<meta>
|
|
<topic id="textsbasicshared03010305xml" indexer="include" status="PUBLISH">
|
|
<title id="tit" xml-lang="en-US">RGB Function</title>
|
|
<filename>/text/sbasic/shared/03010305.xhp</filename>
|
|
</topic>
|
|
</meta>
|
|
|
|
<body>
|
|
<section id="rgb">
|
|
<bookmark xml-lang="en-US" branch="index" id="bm_id851576768070903">
|
|
<bookmark_value>RGB function</bookmark_value>
|
|
</bookmark>
|
|
|
|
<h1 id="hd_id3150792"><link href="text/sbasic/shared/03010305.xhp">RGB Function</link></h1>
|
|
<paragraph id="par_id3150447" role="paragraph" xml-lang="en-US">Returns a <literal>Long</literal> integer color value consisting of red, green, and blue components.</paragraph>
|
|
</section>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
|
|
<bascode>
|
|
<paragraph id="par_id3155132" role="bascode" xml-lang="en-US">RGB (Red, Green, Blue)</paragraph>
|
|
</bascode>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
|
|
<paragraph id="par_id3159153" localize="false" role="paragraph" xml-lang="en-US">Long</paragraph>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
|
|
<section id="parameters">
|
|
<section id="parameters1">
|
|
<paragraph id="par_id3152597" role="paragraph" xml-lang="en-US"> <emph>red</emph>: Any integer expression that represents the red component (0-255) of the composite color.</paragraph>
|
|
<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US"> <emph>green</emph>: Any integer expression that represents the green component (0-255) of the composite color.</paragraph>
|
|
<paragraph id="par_id3151113" role="paragraph" xml-lang="en-US"> <emph>blue</emph>: Any integer expression that represents the blue component (0-255) of the composite color.</paragraph>
|
|
</section>
|
|
<paragraph role="paragraph" id="par_id101639922410794">The resulting <literal>Long</literal> value is calculated with the following formula:<br/>
|
|
<literal>Result = red×65536 + green×256 + blue</literal>.
|
|
</paragraph>
|
|
<warning id="par_id671639922129017">Under VBA compatibility mode (<link href="text/sbasic/shared/03103350.xhp"><literal>Option VBASupport 1</literal></link>), the <literal>Long</literal> value is calculated as
|
|
<br/>
|
|
<literal>Result = red + green×256 + blue×65536</literal><br/>
|
|
See <link href="text/sbasic/shared/03010306.xhp">RGB Function [VBA]</link>
|
|
</warning>
|
|
|
|
<tip id="par_id211587653651037">The <link href="text/shared/optionen/01010501.xhp">color picker dialog</link> helps computing red, green and blue components of a composite color. <link href="text/shared/guide/text_color.xhp">Changing the color of text</link> and selecting <emph>Custom color</emph> displays the color picker dialog.</tip>
|
|
</section>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
|
|
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
|
|
<bascode>
|
|
<paragraph id="par_idm1340938032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleColor</paragraph>
|
|
<paragraph id="par_idm1340936800" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph>
|
|
<paragraph id="par_idm1340935568" role="bascode" localize="false" xml-lang="en-US"> lVar = rgb(128,0,200)</paragraph>
|
|
<paragraph id="par_id3145647" role="bascode" xml-lang="en-US"> MsgBox "The color " & lVar & " consists of:" & Chr(13) &_</paragraph>
|
|
<paragraph id="par_id3154491" role="bascode" xml-lang="en-US"> "red= " & red(lVar) & Chr(13)&_</paragraph>
|
|
<paragraph id="par_id3149401" role="bascode" xml-lang="en-US"> "green= " & green(lVar) & Chr(13)&_</paragraph>
|
|
<paragraph id="par_id3150716" role="bascode" xml-lang="en-US"> "blue= " & blue(lVar) & Chr(13) , 64,"colors"</paragraph>
|
|
<paragraph id="par_idm1340927072" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
|
|
</bascode>
|
|
|
|
</body>
|
|
</helpdocument>
|