この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

apex:attribute

カスタムコンポーネントの属性の定義です。属性タグはコンポーネントタグの子としてのみ指定できます。

名前が id、rendered などである属性は定義できません。これらの属性はすべてのカスタムコンポーネント定義で自動的に作成されます。

1<!-- Page: -->
2
3<apex:page>
4    <c:myComponent myValue="My component's value" borderColor="red" />
5</apex:page>
6
7<!-- Component:myComponent -->
8
9<apex:component>
10    <apex:attribute name="myValue" description="This is the value for the component." type="String" required="true"/>
11    <apex:attribute name="borderColor" description="This is color for the border." type="String" required="true"/>
12
13    <h1 style="border:{!borderColor}">
14        <apex:outputText value="{!myValue}"/>
15    </h1>
16</apex:component>

属性

属性名 属性型 説明 必須項目 API バージョン 通用範囲
access String 属性を同じ名前空間の任意のページ外で属性として使用できるかどうかを指定する。使用できる値は、「public」(デフォルト) および「global」です。属性を属性の名前空間外で使用できるように指定する場合は、global を使用します。親の apex:component のアクセス属性が global に設定されている場合は、このコンポーネントに対しても global に設定する必要があります。親の apex:component のアクセス属性が public に設定されている場合は、このコンポーネントに対して global に設定することはできません。注: この指定がある属性には、appexchange の管理パッケージの説明にある非推奨ポリシーが適用されます。 14.0
assignTo Object 関連付けられているカスタムコンポーネントコントローラでこの属性の値をクラス変数に割り当てる setter メソッド。この属性を使用する場合は、getter メソッドおよび setter メソッドまたは get 値および set 値を含むプロパティを定義する必要があります。 12.0 グローバル
default String 属性のデフォルト値。 13.0 グローバル
description String 属性のテキストによる説明。この説明はカスタムコンポーネントが保存されるとすぐにコンポーネントの参照に含められます。 12.0 グローバル
encode Boolean これは、一���のパッケージインストールに影響する問題に対応する一時オプション。この属性は今後のリリースで廃止されます。Salesforce による指示がない限り使用しないでください。 15.0
id String カスタムコンポーネント定義で他のタグが属性を参照できるようにする識別子。 12.0 グローバル
name String 関連付けられているカスタムコンポーネントが属性の値を含む場合に Visualforce マークアップで使用されている属性の名前。コンポーネントの定義では、この名前はその他すべての属性とは異なり一意である必要があります。id、rendered、action という名前の属性は定義できません。これらの属性は、すべてのカスタムコンポーネントの定義で自動的に作成されるか、または使用できないかのいずれかです。 はい 12.0 グローバル
required Boolean 関連付けられているカスタムコンポーネントが Visualforce ページに含まれる場合に属性の値を指定する必要があるかどうかを指定する boolean 値。true に設定すると、値が必須になります。指定されていない場合、この値はデフォルトの false に設定されます。 12.0 グローバル
type String
属性の Apex データ型。assignTo 属性を使用してこの属性の値をコントローラクラス変数に割り当てる場合、データ型の値とクラス変数のデータ型が一致している必要があります。type 属性は次のデータ型のみを値として使用できます。
  • string、integer、または boolean などのプリミティブデータ型
  • Account などの sObject、My_Custom_Object__c、または汎用型の SObject
  • String[]、Contact[] などの配列表記を使用して指定する一次元リスト
  • type="map" を使用して指定する対応付け。対応付けの特定のデータ型を指定する必要はありません。
  • カスタム Apex データ型 (クラス)
はい 12.0 グローバル