<?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>
<h1 id="hd_id3148947"><link href="text/sbasic/shared/03010303.xhp">Red Function</link></h1>
<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Returns the Red component of the specified composite color code.</paragraph>
</section>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
<paragraph id="par_id3150448" role="bascode" xml-lang="en-US">Red (ColorNumber As Long)</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
<paragraph id="par_id3145173" role="paragraph" xml-lang="en-US">Integer</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<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>
<warning id="par_id671639922129017">Under VBA compatibility mode (<link href="text/sbasic/shared/03103350.xhp"><literal>Option VBASupport 1</literal></link>), the function Red() is incompatible with VBA colors, when color from previous call to <link href="text/sbasic/shared/03010306.xhp"><literal>function RGB [VBA]</literal></link> is passed.
</warning>
<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">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">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#functexample"/>
<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 " & lVar & " consists of:" & Chr(13) &_</paragraph>
<paragraph id="par_id3155306" role="bascode" xml-lang="en-US"> "red= " & red(lVar) & Chr(13)&_</paragraph>
<paragraph id="par_id3149262" role="bascode" xml-lang="en-US"> "green= " & green(lVar) & Chr(13)&_</paragraph>
<paragraph id="par_id3147397" role="bascode" xml-lang="en-US"> "blue= " & blue(lVar) & Chr(13) , 64,"colors"</paragraph>
<paragraph id="par_idm1341081888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>
</helpdocument>