CFPROPERTY | |
説明
ColdFusion コンポーネント (CFC) のプロパティを定義します。Web サービス用の複合データタイプの作成に使用します。このタグの属性は、コンポーネントのメタデータとして示され、継承ルールが適用されます。 |
|
カテゴリ
拡張タグ | |
シンタックス<cfproperty name="name" type="type" required="boolean" default="default value" displayname="descriptive name" hint="extended description" > |
|
関連項目
cfargument、cfcomponent、cffunction、cfinvoke、cfinvokeargument、cfobject、cfreturn、『ColdFusion MX 開発ガイド』の第10章の「ColdFusion コンポーネントの作成と使用」 の「CFC のドキュメント化」 |
|
ヒストリ
ColdFusion MX: このタグが追加されました。
|
|
使用方法
cfproperty タグは、コンポーネントの最初の、実行可能コードと関数定義よりも上に配置する必要があります。 コンポーネントを Web サービスとして使用しない場合は、イントロスペクションを使ってコンポーネントを表示するとき (たとえば、ブラウザで CFC ファイルを直接開くときなど) にのみ、cfproperty によってメタデータ情報が提供されます。コンポーネントで使用できる変数の定義や値の設定は行われません。 ColdFusion で作成する Web サービスについては、Web サービスで使用する複雑な変数が cfproperty タグによって定義されます。 |
|
例
次のコードでは、住所を表すプロパティが含まれる address.cfc ファイルのコンポーネントを定義しています。 <cfcomponent> <cfproperty name="Number" type="numeric"> <cfproperty name="Street" type="string"> <cfproperty name="City" type="string"> <cfproperty name="State" type="string"> <cfproperty name="Country" type="string"> </cfcomponent> このコンポーネントで表される複合データタイプは、次のように Web サービスとしてエクスポートされるコンポーネントで使用できます。 <cfcomponent> <cffunction name="echoAddress" returnType="address" access="remote"> <cfargument name="input" type="address"> <cfreturn arguments.input> </cffunction> </cfcomponent> |
NAME | |
必須 | |
文字列です。プロパティ名を指定します。スタティックな値である必要があります。 |
TYPE | |
オプション | |
Default value: "any"
文字列です。プロパティデータタイプを指定します。
|
REQUIRED | |
オプション | |
Default value: "no"
パラメータが必要かどうかを指定します。
|
DEFAULT | |
オプション | |
コンポーネントを Web サービスで使用するときにプロパティ値が設定されていない場合、デフォルト値が指定されます。 この属性を指定する場合は、required 属性を "no" に設定します。あるいは、required 属性を指定しないでください。 |
DISPLAYNAME | |
オプション | |
イントロスペクションを使用して CFC についての情報を示すときに表示される値です。この値はプロパティ名の後ろの括弧内に表示されます。 |
HINT | |
オプション | |
イントロスペクションを使用して CFC についての情報を示すときに表示されるテキストです。この属性は、パラメータの目的を説明するのに役立ちます。 |