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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3
   4 <!--***********************************************************************
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * Copyright 2008 by Sun Microsystems, Inc.
   9  *
  10  * OpenOffice.org - a multi-platform office productivity suite
  11  *
  12  * $RCSfile: 03010303.xhp,v $
  13  * $Revision: 1.5 $
  14  *
  15  * This file is part of OpenOffice.org.
  16  *
  17  * OpenOffice.org is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Lesser General Public License version 3
  19  * only, as published by the Free Software Foundation.
  20  *
  21  * OpenOffice.org is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Lesser General Public License version 3 for more details
  25  * (a copy is included in the LICENSE file that accompanied this code).
  26  *
  27  * You should have received a copy of the GNU Lesser General Public License
  28  * version 3 along with OpenOffice.org.  If not, see
  29  * <http://www.openoffice.org/license.html>
  30  * for a copy of the LGPLv3 License.
  31  *
  32  ************************************************************************-->
  33
  34 <helpdocument version="1.0">
  35 <meta>
  36 <topic id="textsbasicshared03010303xml" indexer="include" status="PUBLISH">
  37 <title id="tit" xml-lang="en-US">Red Function [Runtime]</title>
  38 <filename>/text/sbasic/shared/03010303.xhp</filename>
  39 </topic>
  40 <history>
  41 <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
  42 <lastedited date="2004-09-01T15:12:52">converted from old format - fpe</lastedited>
  43 </history>
  44 </meta>
  45 <body>
  46 <section id="red">
  47 <bookmark xml-lang="en-US" branch="index" id="bm_id3148947"><bookmark_value>Red function</bookmark_value>
  48 </bookmark>
  49 <paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03010303.xhp" name="Red Function [Runtime]">Red Function [Runtime]</link></paragraph>
  50 <paragraph role="paragraph" id="par_id3149656" xml-lang="en-US" l10n="U" oldref="2">Returns the Red component of the specified color code.</paragraph>
  51 </section>
  52 <paragraph role="heading" id="hd_id3148799" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
  53 <paragraph role="code" id="par_id3150448" xml-lang="en-US" l10n="U" oldref="4">Red (ColorNumber As Long)</paragraph>
  54 <paragraph role="heading" id="hd_id3151042" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
  55 <paragraph role="paragraph" id="par_id3145173" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
  56 <paragraph role="heading" id="hd_id3154685" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
  57 <paragraph role="paragraph" id="par_id3150440" xml-lang="en-US" l10n="U" oldref="8">
  58 <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>
  59 <embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
  60 <embed href="text/sbasic/shared/00000003.xhp#err5"/>
  61 <paragraph role="heading" id="hd_id3148575" xml-lang="en-US" level="2" l10n="U" oldref="9">Example:</paragraph>
  62 <paragraph role="code" id="par_id3145365" xml-lang="en-US" l10n="U" oldref="10">Sub ExampleColor</paragraph>
  63 <paragraph role="code" id="par_id3147348" xml-lang="en-US" l10n="U" oldref="11">Dim lVar As Long</paragraph>
  64 <paragraph role="code" id="par_id3145750" xml-lang="en-US" l10n="U" oldref="12">lVar = rgb(128,0,200)</paragraph>
  65 <paragraph role="code" id="par_id3147435" xml-lang="en-US" l10n="U" oldref="13">msgbox "The color " &amp; lVar &amp; " consists of:" &amp; Chr(13) &amp;_</paragraph>
  66 <paragraph role="code" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="14">"red= " &amp; red(lVar) &amp; Chr(13)&amp;_</paragraph>
  67 <paragraph role="code" id="par_id3149262" xml-lang="en-US" l10n="U" oldref="15">"green= " &amp; green(lVar) &amp; Chr(13)&amp;_</paragraph>
  68 <paragraph role="code" id="par_id3147397" xml-lang="en-US" l10n="U" oldref="16">"blue= " &amp; blue(lVar) &amp; Chr(13) , 64,"colors"</paragraph>
  69 <paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U" oldref="17">end sub</paragraph>
  70 </body>
  71 </helpdocument>