helpcontent2/source/text/sbasic/shared/03010305.xhp


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

<?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&#215;65536 + green&#215;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&#215;256 + blue&#215;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 " &amp; lVar &amp; " consists of:" &amp; Chr(13) &amp;_</paragraph>
<paragraph id="par_id3154491" role="bascode" xml-lang="en-US">        "red= " &amp; red(lVar) &amp; Chr(13)&amp;_</paragraph>
<paragraph id="par_id3149401" role="bascode" xml-lang="en-US">        "green= " &amp; green(lVar) &amp; Chr(13)&amp;_</paragraph>
<paragraph id="par_id3150716" role="bascode" xml-lang="en-US">        "blue= " &amp; blue(lVar) &amp; Chr(13) , 64,"colors"</paragraph>
<paragraph id="par_idm1340927072" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>

</body>
</helpdocument>