<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link href="mmres://user_interface_reference.css" rel="stylesheet" type="text/css">
<title>CFPROPERTY</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
   <div id="説明">
   <table cellpadding="0" cellspacing="0" border="0" width="100%" class="main">
      <tr> 
         <td valign="top" class="name">CFPROPERTY</td>
         <td valign="top" nowrap class="compatibility">&nbsp;</td>
      </tr>
      <tr>
         <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
      </tr>


    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">説明</span>
<p>
ColdFusion コンポーネント (CFC) のプロパティを定義します。Web サービス用の複合データタイプの作成に使用します。このタグの属性は、コンポーネントのメタデータとして示され、継承ルールが適用されます。
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">カテゴリ</span>
<p>
拡張タグ
</p>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="syntax"><span class="title">シンタックス</span><pre>&lt;cfproperty
   name=&quot;name&quot;
   type=&quot;type&quot;
   required=&quot;boolean&quot;
   default=&quot;default value&quot;
   displayname=&quot;descriptive name&quot;
   hint=&quot;extended description&quot;
   &gt;
</pre>    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">関連項目</span>
<p>
cfargument、cfcomponent、cffunction、cfinvoke、cfinvokeargument、cfobject、cfreturn、『ColdFusion MX 開発ガイド』の第10章の「ColdFusion コンポーネントの作成と使用」 の「CFC のドキュメント化」
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">ヒストリ</span>
<p>
ColdFusion&#160;MX: このタグが追加されました。
</p>

<p>

</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">使用方法</span>
<p>
cfproperty タグは、コンポーネントの最初の、実行可能コードと関数定義よりも上に配置する必要があります。 
</p>

<p>
コンポーネントを Web サービスとして使用しない場合は、イントロスペクションを使ってコンポーネントを表示するとき (たとえば、ブラウザで CFC ファイルを直接開くときなど) にのみ、cfproperty によってメタデータ情報が提供されます。コンポーネントで使用できる変数の定義や値の設定は行われません。
</p>

<p>
ColdFusion で作成する Web サービスについては、Web サービスで使用する複雑な変数が cfproperty タグによって定義されます。 
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">例</span>
<p>
次のコードでは、住所を表すプロパティが含まれる address.cfc ファイルのコンポーネントを定義しています。
</p>
<pre>&lt;cfcomponent&gt;
   &lt;cfproperty name=&quot;Number&quot; type=&quot;numeric&quot;&gt;
   &lt;cfproperty name=&quot;Street&quot; type=&quot;string&quot;&gt;
   &lt;cfproperty name=&quot;City&quot; type=&quot;string&quot;&gt;
   &lt;cfproperty name=&quot;State&quot; type=&quot;string&quot;&gt;
   &lt;cfproperty name=&quot;Country&quot; type=&quot;string&quot;&gt;
&lt;/cfcomponent&gt;
</pre>
<p>
このコンポーネントで表される複合データタイプは、次のように Web サービスとしてエクスポートされるコンポーネントで使用できます。
</p>
<pre>&lt;cfcomponent&gt;
   &lt;cffunction name=&quot;echoAddress&quot; returnType=&quot;address&quot; access=&quot;remote&quot;&gt;
         &lt;cfargument name=&quot;input&quot; type=&quot;address&quot;&gt;
         &lt;cfreturn arguments.input&gt;
   &lt;/cffunction&gt;
&lt;/cfcomponent&gt;
</pre>
         </td>
      </tr>
   </table>
   </div>
<div id="NAME">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">NAME</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>

  <tr>
  <td valign="top" class="syntax">&nbsp;</td>
  <td valign="top" nowrap class="requirements">必須</td>
  </tr>
  <tr>
  <td colspan="2" class="clearseparation">&nbsp;</td>
  </tr>
  <tr>
  <td valign="top" colspan="2" class="description">



<p>文字列です。プロパティ名を指定します。スタティックな値である必要があります。</p>

  </td>
  </tr>
  </table>
</div>
<div id="TYPE ">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">TYPE </td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>

  <tr>
  <td valign="top" class="syntax">&nbsp;</td>
  <td valign="top" nowrap class="requirements">オプション</td>
  </tr>
  <tr>
  <td colspan="2" class="clearseparation">&nbsp;</td>
  </tr>
  <tr>
  <td valign="top" colspan="2" class="description">

<strong>Default value:</strong> "any"


<p>文字列です。プロパティデータタイプを指定します。</p><ul>

<li>any</li>

<li>array</li>

<li>binary</li>

<li>boolean</li>

<li>date</li>

<li>guid: この引数は <i>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</i> という形式の UUID または GUID でなければなりません。<i>x</i> は 16 進数の 1 文字を表します (0 ～ 9、A ～ F)。</li>

<li>numeric</li>

<li>query</li>

<li>string</li>

<li>struct</li>

<li>uuid: この引数は <i>xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx</i> という形式の ColdFusion UUID でなければなりません。<i>x</i> は 16 進数の 1 文字を表します (0 ～ 9、A ～ F)。</li>

<li>variableName: ColdFusion 変数のネーミング規則に従った形式の文字列</li>

<li>コンポーネント名: type 属性の値が上記のどれにも当てはまらない場合、ColdFusion はそれを ColdFusion コンポーネントの名前として扱います。関数を実行したときに、渡された引数が指定の名前を持つ CFC でない場合はエラーになります。</li>
</ul>


  </td>
  </tr>
  </table>
</div>
<div id="REQUIRED">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">REQUIRED</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>

  <tr>
  <td valign="top" class="syntax">&nbsp;</td>
  <td valign="top" nowrap class="requirements">オプション</td>
  </tr>
  <tr>
  <td colspan="2" class="clearseparation">&nbsp;</td>
  </tr>
  <tr>
  <td valign="top" colspan="2" class="description">

<strong>Default value:</strong> "no"


<p>パラメータが必要かどうかを指定します。 </p><ul>

<li>yes</li>

<li>no</li>
</ul>


  </td>
  </tr>
  </table>
</div>
<div id="DEFAULT">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">DEFAULT</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>

  <tr>
  <td valign="top" class="syntax">&nbsp;</td>
  <td valign="top" nowrap class="requirements">オプション</td>
  </tr>
  <tr>
  <td colspan="2" class="clearseparation">&nbsp;</td>
  </tr>
  <tr>
  <td valign="top" colspan="2" class="description">



<p>コンポーネントを Web サービスで使用するときにプロパティ値が設定されていない場合、デフォルト値が指定されます。 </p>
<p>この属性を指定する場合は、required 属性を &quot;no&quot; に設定します。あるいは、required 属性を指定しないでください。 </p>

  </td>
  </tr>
  </table>
</div>
<div id="DISPLAYNAME">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">DISPLAYNAME</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>

  <tr>
  <td valign="top" class="syntax">&nbsp;</td>
  <td valign="top" nowrap class="requirements">オプション</td>
  </tr>
  <tr>
  <td colspan="2" class="clearseparation">&nbsp;</td>
  </tr>
  <tr>
  <td valign="top" colspan="2" class="description">



<p>イントロスペクションを使用して CFC についての情報を示すときに表示される値です。この値はプロパティ名の後ろの括弧内に表示されます。</p>

  </td>
  </tr>
  </table>
</div>
<div id="HINT">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">HINT</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>

  <tr>
  <td valign="top" class="syntax">&nbsp;</td>
  <td valign="top" nowrap class="requirements">オプション</td>
  </tr>
  <tr>
  <td colspan="2" class="clearseparation">&nbsp;</td>
  </tr>
  <tr>
  <td valign="top" colspan="2" class="description">



<p>イントロスペクションを使用して CFC についての情報を示すときに表示されるテキストです。この属性は、パラメータの目的を説明するのに役立ちます。</p>

  </td>
  </tr>
  </table>
</div>

  </body>
</html>
