summaryrefslogtreecommitdiffstats
path: root/source/text/sbasic/shared/03010303.xhp
blob: 1dfc411f000b655174118e0d70a040da00236aea (plain)
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
<?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="textsbasicshared03010303xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">Red Function</title>
    <filename>/text/sbasic/shared/03010303.xhp</filename>
  </topic>
</meta>

<body>


<section id="red">
<bookmark xml-lang="en-US" branch="index" id="bm_id3148947">
  <bookmark_value>Red function</bookmark_value>
</bookmark>


<paragraph id="hd_id3148947" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010303.xhp" name="Red Function">Red Function</link></paragraph>
<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Returns the Red component of the specified composite color code.</paragraph>
</section>

<paragraph id="hd_id3148799" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3150448" role="bascode" xml-lang="en-US">Red (ColorNumber As Long)</paragraph>
</bascode>

<paragraph id="hd_id3151042" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3145173" role="paragraph" xml-lang="en-US">Integer</paragraph>

<paragraph id="hd_id3154685" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph>
<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US"> <emph>ColorNumber</emph>: Long integer expression that specifies any composite color code for which to return the Red component.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>

<section id="ColorPickerDialog">
  <tip id="par_id961588421825749">The <link href="text/shared/optionen/01010501.xhp" name="color picker dialog">color picker dialog</link> details the red, green and blue components of a composite color code, as well as its hexadecimal expression. <link href="text/shared/guide/text_color.xhp" name="Changing the color of text">Changing the color of text</link> and selecting <emph>Custom color</emph> displays the color picker dialog.</tip>
</section>

<paragraph id="hd_id3148575" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341092848" role="bascode" localize="false" xml-lang="en-US">Sub ExampleColor</paragraph>
<paragraph id="par_idm1341091616" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph>
<paragraph id="par_idm1341090384" role="bascode" localize="false" xml-lang="en-US">    lVar = rgb(128,0,200)</paragraph>
<paragraph id="par_id3147435" role="bascode" xml-lang="en-US">    MsgBox "The color " &amp; lVar &amp; " consists of:" &amp; Chr(13) &amp;_</paragraph>
<paragraph id="par_id3155306" role="bascode" xml-lang="en-US">        "red= " &amp; red(lVar) &amp; Chr(13)&amp;_</paragraph>
<paragraph id="par_id3149262" role="bascode" xml-lang="en-US">        "green= " &amp; green(lVar) &amp; Chr(13)&amp;_</paragraph>
<paragraph id="par_id3147397" role="bascode" xml-lang="en-US">        "blue= " &amp; blue(lVar) &amp; Chr(13) , 64,"colors"</paragraph>
<paragraph id="par_idm1341081888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>