xref: /trunk/main/helpcontent2/source/text/sbasic/shared/03010303.xhp (revision bb8a81051a63ccfb894fdf214434243d07907746)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
5d33d0967SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6d33d0967SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7d33d0967SAndrew Rist * distributed with this work for additional information
8d33d0967SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9d33d0967SAndrew Rist * to you under the Apache License, Version 2.0 (the
10d33d0967SAndrew Rist * "License"); you may not use this file except in compliance
11d33d0967SAndrew Rist * with the License.  You may obtain a copy of the License at
12cdf0e10cSrcweir *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
15d33d0967SAndrew Rist * Unless required by applicable law or agreed to in writing,
16d33d0967SAndrew Rist * software distributed under the License is distributed on an
17d33d0967SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18d33d0967SAndrew Rist * KIND, either express or implied.  See the License for the
19d33d0967SAndrew Rist * specific language governing permissions and limitations
20d33d0967SAndrew Rist * under the License.
21cdf0e10cSrcweir *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03010303xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Red Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03010303.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="red">
338b0727e7Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3148947">
348b0727e7Smseidel<bookmark_value>Red function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*bb8a8105Smseidel<paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03010303.xhp" name="Red Function [Runtime]">Red Function [Runtime]</link></paragraph>
37*bb8a8105Smseidel<paragraph role="paragraph" id="par_id3149656" xml-lang="en-US" l10n="U">Returns the Red component of the specified color code.</paragraph>
38cdf0e10cSrcweir</section>
39*bb8a8105Smseidel<paragraph role="heading" id="hd_id3148799" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40*bb8a8105Smseidel<paragraph role="code" id="par_id3150448" xml-lang="en-US" l10n="U">Red (ColorNumber As Long)</paragraph>
41*bb8a8105Smseidel<paragraph role="heading" id="hd_id3151042" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42*bb8a8105Smseidel<paragraph role="paragraph" id="par_id3145173" xml-lang="en-US" l10n="U">Integer</paragraph>
43*bb8a8105Smseidel<paragraph role="heading" id="hd_id3154685" xml-lang="en-US" level="2" l10n="U">Parameter:</paragraph>
44*bb8a8105Smseidel<paragraph role="paragraph" id="par_id3150440" xml-lang="en-US" l10n="U"><emph>ColorNumber:</emph> Long integer expression that specifies any <link href="text/sbasic/shared/00000003.xhp#farbcodes" name="color code">color code</link> for which to return the Red component.</paragraph>
45cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
46cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
47*bb8a8105Smseidel<paragraph role="heading" id="hd_id3148575" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
48*bb8a8105Smseidel<paragraph role="code" id="par_id3145365" xml-lang="en-US" l10n="U">Sub ExampleColor</paragraph>
49*bb8a8105Smseidel<paragraph role="code" id="par_id3147348" xml-lang="en-US" l10n="U">Dim lVar As Long</paragraph>
50*bb8a8105Smseidel<paragraph role="code" id="par_id3145750" xml-lang="en-US" l10n="U">lVar = rgb(128,0,200)</paragraph>
51*bb8a8105Smseidel<paragraph role="code" id="par_id3147435" xml-lang="en-US" l10n="U">msgbox "The color " &amp; lVar &amp; " consists of:" &amp; Chr(13) &amp;_</paragraph>
52*bb8a8105Smseidel<paragraph role="code" id="par_id3155306" xml-lang="en-US" l10n="U">"red= " &amp; red(lVar) &amp; Chr(13)&amp;_</paragraph>
53*bb8a8105Smseidel<paragraph role="code" id="par_id3149262" xml-lang="en-US" l10n="U">"green= " &amp; green(lVar) &amp; Chr(13)&amp;_</paragraph>
54*bb8a8105Smseidel<paragraph role="code" id="par_id3147397" xml-lang="en-US" l10n="U">"blue= " &amp; blue(lVar) &amp; Chr(13) , 64,"colors"</paragraph>
55*bb8a8105Smseidel<paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U">end sub</paragraph>
56cdf0e10cSrcweir</body>
57cdf0e10cSrcweir</helpdocument>
58