A ADFデスクトップ統合コンポーネントのプロパティとアクション

ADFデスクトップ統合コンポーネントのプロパティを一覧表示し、それについて説明します。特定のコンポーネントによって公開されるアクションについても説明します。

この付録の内容は次のとおりです。

ADFデスクトップ統合で頻繁に使用するプロパティ

多くのコンポーネントで参照されるADFデスクトップ統合のプロパティを、アルファベット順に示します。

表A-1 ADFデスクトップ統合で頻繁に使用するプロパティ

名前 EL 説明

ActionSet

N

アクション・セットの詳細は、「アクション・セットのプロパティ」を参照してください。

Annotation

String

N

このフィールドを使用して、ワークシートでのコンポーネントの使用に関するコメントを入力します。入力したコメントは、ワークブックの動作に影響を与えません。これは、コードのコメントに相当するものです。

ComponentID

String

N

ADFデスクトップ統合によってこの文字列が生成されることで、統合ExcelワークブックでADFコンポーネントの各インスタンスが一意に識別されます。

Label

String

Y

実行時に評価されるEL式を指定します。ADFデスクトップ統合でのEL式の詳細は、「ADFデスクトップ統合のEL式」を参照してください。ラベルの使用の詳細は、「統合Excelワークブックでのラベルの使用」を参照してください。

Position

N

このプロパティは、統合ExcelワークブックのOracle ADFコンポーネントの左上隅を定義します。

ReadOnly

Boolean

Y

このプロパティをTrueに設定すると、ADFデスクトップ統合は、このプロパティを使用するコンポーネントを参照するセルにユーザーが加える変更を無視します。「ワークシート保護の使用」で説明されているように、この設定を自動ワークシート保護と組み合せて使用している場合は、セルをロックすることもできます。

エンド・ユーザーの混乱を避けるため、ReadOnlyTrueに設定したセルには、セルのコンテンツが変更不可であることを視覚的に判断できるスタイルを適用します。スタイルの適用の詳細は、「スタイルの使用」を参照してください。

StyleName

String

Y

Oracle ADFコンポーネントのレンダリング時に適用される現在のExcelワークブックのスタイルを指定します。詳細は、「スタイルの使用」を参照してください。

Tooltip

String

Y

ADFフォーム・コンポーネントのコンテンツまたは関数、あるいは表の列に関するヒント・メッセージを指定して、コンポーネントまたは列の上にマウス・カーソルを重ねたときに表示されるようにします。

詳細は、「ADFデスクトップ統合コンポーネントでのツールチップの表示」を参照してください。

Value

各種

Y

このプロパティは、通常は、ADF表コンポーネントのDownloadおよびRowDownSyncアクションまたはワークシートのDownSyncアクションの起動中に評価されるELバインディング値式を参照します。生成されるデータ値は、実行時にワークシートに表示されます。

多くのラベル型プロパティはオプションで、デフォルトは空の値です。実行時に、このようなプロパティの値が空の場合、ADFデスクトップ統合ではデフォルトのローカライズされた値が指定されます。プロパティの値を空として表示する場合、その値を1つの空白文字に設定するか、空の文字列に評価するEL式を指定します。

ADF入力テキスト・コンポーネントのプロパティ

ADF入力テキスト・コンポーネントのプロパティをアルファベット順に示します。

表A-2 ADF入力テキスト・コンポーネントのプロパティ

名前 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

InputText.DoubleClickActionSet

ユーザーがセルをダブルクリックすると起動するアクション・セットを指定します。アクション・セットの詳細は、「アクション・セットのプロパティ」を参照してください。

InputText.ReadOnly

このプロパティの詳細は、表A-1を参照してください。

InputText.Value

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

StyleName

このプロパティの詳細は、表A-1を参照してください。

Tooltip

このプロパティの詳細は、表A-1を参照してください。

ADF出力テキスト・コンポーネントのプロパティ

ADF出力テキスト・コンポーネントのプロパティをアルファベット順に示します。

表A-3 ADF出力テキスト・コンポーネントのプロパティ

名前 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

OutputText.DoubleClickActionSet

ユーザーがセルをダブルクリックすると起動するアクション・セットを指定します。アクション・セットの詳細は、「アクション・セットのプロパティ」を参照してください。

OutputText.Value

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

StyleName

このプロパティの詳細は、表A-1を参照してください。

Tooltip

このプロパティの詳細は、表A-1を参照してください。

ADFラベル・コンポーネントのプロパティ

ADFラベル・コンポーネントは、実行時に静的な文字列値を表示します。ADFデスクトップ統合は、Labelプロパティが参照するEL式が評価されると値を生成します。

ラベルの使用の詳細は、「統合Excelワークブックでのラベルの使用」を参照してください。

表A-4に、ADFラベル・コンポーネントが参照するプロパティをアルファベット順に示します。

表A-4 ADFラベル・コンポーネントのプロパティ

名前 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

Label

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

StyleName

このプロパティの詳細は、表A-1を参照してください。

Tooltip

このプロパティの詳細は、表A-1を参照してください。

ADF値リスト・コンポーネントのプロパティ

ADFラベル・コンポーネントが参照するプロパティを示します。

統合Excelワークブックの値リストの作成の詳細は、「値リストの使用」を参照してください。

表A-5 ADF値リスト・コンポーネントのプロパティ

名前 EL 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

ListOfValues.DependsOnListID

リスト・バインディング

N

リスト・バインディングを選択すると、依存値リストで実行時に使用できる選択肢を判断するために、その値が使用されます。

選択するリスト・バインディングは、モデルドリブン・リストでも構いません。

依存値リストの詳細は、「統合Excelワークブックでの依存値リストの作成」を参照してください。

ListOfValues.ListID

リスト・バインディング

N

値のリストで使用可能な値を定義するリスト・バインディングを選択します。選択するリスト・バインディングは、モデルドリブン・リストでも構いません。

ListOfValues.ReadOnly

Boolean

N

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

StyleName

このプロパティの詳細は、表A-1を参照してください。

Tooltip

String

Y

このプロパティの詳細は、表A-1を参照してください。

ADFイメージ・コンポーネントのプロパティ

実行時にイメージを表示するADFイメージ・コンポーネントのプロパティを示します。

ADFイメージ・コンポーネントの詳細は、「ADFイメージ・コンポーネントの挿入」を参照してください。

表A-6 ADFラベル・コンポーネントのプロパティ

名前 説明

Source

イメージ・ファイルのURL(絶対または相対)を入力します。

ShortDesc

イメージ・コンポーネントの代替テキストに解決されるEL式を入力します。

Annotation

このプロパティの詳細は、表A-1を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

ADF入力日コンポーネントのプロパティ

ADF入力日コンポーネントのプロパティをアルファベット順に示します。

ADF入力日付コンポーネントの詳細は、「ADF入力日コンポーネントの挿入」を参照してください。

表A-7 ADF入力日コンポーネントのプロパティ

名前 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

InputDate.ReadOnly

このプロパティの詳細は、表A-1を参照してください。

InputDate.Value

実行時に日付/時刻の値に解決するEL式を指定します。ADF入力日付コンポーネントの詳細は、「ADF入力日コンポーネントの挿入」を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

StyleName

このプロパティの詳細は、表A-1を参照してください。

Tooltip

このプロパティの詳細は、表A-1を参照してください。

ModelDrivenColumnComponentサブコンポーネントのプロパティ

ModelDrivenColumnComponentサブコンポーネントに対して構成するプロパティを示します。

ModelDrivenColumnComponentサブコンポーネントは、ADFデスクトップ統合の作業ウィンドウのコンポーネント・パレットには表示されません。かわりに、「ADF表コンポーネントの列プロパティ」で説明しているADF表コンポーネントの表の列プロパティUpdateComponentまたはInsertComponentに対して起動するサブコンポーネントとしてModelDrivenColumnComponentを指定する際に、このサブコンポーネントのプロパティを構成します。

列サブコンポーネントのタイプは、サーバー上に指定された列の属性のコントロール・タイプのヒントにより、実行時に決まります。たとえば、属性に関連付けられたモデルドリブン・リストがある場合、列は、モデルドリブン・リストを含むドロップダウン・リストを実行時に使用します。「ADF表コンポーネントへのModelDrivenColumnComponentサブコンポーネントの追加」を参照してください。

表A-8 ModelDrivenColumnComponentサブコンポーネントのプロパティ

名前 EL 説明

DoubleClickActionSet

ユーザーがセルをダブルクリックすると起動するアクション・セットを指定します。アクション・セットの詳細は、「アクション・セットのプロパティ」を参照してください。

ReadOnly

Boolean

Y

ユーザーに列の値を編集させる場合は、ReadOnlyプロパティをFalseに設定し、それ以外の場合は、Trueに設定します。デフォルト値は、Falseです。

「バインディング」パレットでツリー・バインディングをダブルクリックして、ADF表コンポーネントを作成すると、プロパティの値は、実行時にTrueまたはFalseに評価される、次の形式のEL式に設定されます。

#{bindings.{tree-id}.hints.{attr-id}.readOnly}

例: #{bindings.Customers.hints.Address.readOnly}

このプロパティの詳細は、表A-1を参照してください。

Value

各種

Y

このプロパティの詳細は、表A-1を参照してください。

TreeNodeListサブコンポーネントのプロパティ

TreeNodeListサブコンポーネントに対して構成するプロパティを示します。

注意:

ModelDrivenColumnComponentサブコンポーネントは、モデルドリブン・リストを含むツリー・バインディング属性のドロップダウン・メニューもレンダリングします。TreeNodeListサブコンポーネントではなく、ModelDrivenColumnComponentサブコンポーネントを使用することを検討してください。「ModelDrivenColumnComponentサブコンポーネントのプロパティ」を参照してください。

TreeNodeListは、ADF表サブコンポーネントの1つで、実行時にADF表コンポーネントの列にドロップダウン・メニューをレンダリングします。ADF値リスト・コンポーネントと同じ機能をエンド・ユーザーに提供します。統合Excelワークブックの値リストの作成の詳細は、「値リストの使用」を参照してください。

TreeNodeListサブコンポーネントは、ADFデスクトップ統合の作業ウィンドウのコンポーネント・パレットには表示されません。かわりに、「ADF表コンポーネントの列プロパティ」で説明しているADF表コンポーネントの表の列プロパティUpdateComponentまたはInsertComponentに対して起動するサブコンポーネントとしてTreeNodeListを指定する際に、このサブコンポーネントのプロパティを構成します。

表A-9 TreeNodeListサブコンポーネントのプロパティ

名前 EL 説明

DependsOnList

ツリー・バインディング属性またはリスト・バインディング

Y

依存値リストで親値リストとして機能するツリー・バインディング属性またはリスト・バインディングを指定します。

指定するツリー・バインディング属性は、モデルドリブン・リストと関連付けられている必要があります。

依存値リストの詳細は、「統合Excelワークブックでの依存値リストの作成」を参照してください。

List

ツリー・バインディング属性

Y

ADF表コンポーネントの列に表示されるランタイム・ドロップダウン・メニューで使用可能な値を定義する、モデルドリブン・リストに関連付けられているツリー・バインディング属性を指定します。

ReadOnly

Boolean

Y

このサブコンポーネントで使用する場合は、現在サポートされていないため、プロパティの値は常にTrueに設定します。読取り専用の列の場合は、ModelDrivenColumnComponentサブコンポーネントまたはOutputTextコンポーネントを使用することを検討してください。

ADF表コンポーネントのプロパティおよびアクション

ADF表コンポーネントは、ここに示すプロパティおよびコンポーネント・アクションを使用します。

ADF表コンポーネントのプロパティ

表A-10に、ADF表コンポーネントが使用するプロパティをアルファベット順に示します。

表A-10 ADF表コンポーネントのプロパティ

名前 EL 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

BatchOptions

このプロパティ・グループでは、ADF表コンポーネントのバッチ・オプションを構成できます。これらのプロパティの使用方法は、「ADF表コンポーネントでのバッチ処理」を参照してください。

BatchOptions.BatchSize

Integer

N

ADF表コンポーネントのアクション(UploadまたはDeleteFlaggedRows)によってCommitBatchActionIDが起動される前に処理する行数を指定します。正の整数以外の値の場合、1回のバッチですべての行が処理されます。デフォルト値は100行です。

このプロパティの値は必須です。

BatchOptions.CommitBatchActionID

アクション・バインディング

N

BatchSizeで指定した行数が処理されると起動するアクション・バインディングを指定します。アクション・バインディングは、コミット・タイプのアクションになります。

BatchOptions.LimitBatchSize

Boolean

N

このプロパティをTrueに設定すると、行がバッチで処理され、各バッチにはBatchSizeで指定した行数が含まれます。Falseに設定すると、すべての行が1回のバッチで処理されます。

BatchOptions.StartBatchActionID

アクション・バインディング

N

各バッチの開始時に起動するアクション・バインディングを指定します。たとえば、特定のデータベースで必要に応じて、このプロパティを「トランザクションの開始」などの操作に使用できます。

このプロパティの値はオプションです。

DisplayUploadOptions

Boolean

N

ADF表コンポーネントからデータをアップロードする際に、「アップロード・オプション」ダイアログを表示するには、Trueに設定します。

「アップロード・オプションに関する必知事項」を参照してください。

Columns

列の配列。配列の各列によりサポートされるプロパティの詳細は、「ADF表コンポーネントの列プロパティ」を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

ResizeColumnsMode

表全体の列がサイズ変更されるかどうか、およびサイズ変更の方法を制御します。

「実行時にデータに基づいて列をサイズ変更するためのADF表コンポーネントの構成」を参照してください。

RowActions

このプロパティ・グループでは、有効で起動可能なアクションを指定できます。

RowActions.AutoConvertNewRowsEnabled

Boolean

N

Trueの場合、エンド・ユーザーは、新しいデータを統合Excel以外のワークブックからADF表コンポーネントの行に挿入したり、ADF表コンポーネントの行を編集して、ADF表コンポーネントの行に変換したりできます。「ADF表コンポーネントでの行の挿入または貼付け方法」を参照してください。デフォルト値はTrueです。

行の挿入をサポートしていない、または計算行が表に必要なADF表コンポーネントの場合は、Falseに設定します。

RowActions.AutoRefreshRowActionID

メソッド・アクション・バインディング

N

TriggersRowRefreshプロパティがTrueに設定された列のセルを編集してエンド・ユーザーが行リフレッシュをトリガーしたときに起動するメソッド・アクション・バインディングを指定します。この機能を有効にするには、ADF表コンポーネントのRowActions.AutoRefreshRowEnabledプロパティをTrueに設定する必要もあります。

デフォルトでは、このプロパティに値は設定されていません。

「ADF表コンポーネントの自動行リフレッシュの構成」を参照してください。

RowActions.AutoRefreshRowEnabled

Boolean

N

Trueの場合、エンド・ユーザーは、TriggersRowRefreshプロパティがTrueに設定された列のセルを編集することにより行リフレッシュをトリガーできます。このプロパティのデフォルト値は、FALSEです。

「ADF表コンポーネントの自動行リフレッシュの構成」を参照してください。

RowActions.DeleteRowActionID

アクション・バインディング

N

フラグ付けされた各行を削除するために起動するアクション・バインディングを指定します。

このプロパティの値はオプションです。

RowActions.DeleteRowEnabled

Boolean

N

Trueに設定すると、既存の行を削除できます。デフォルト値はFalseです。

このプロパティの値は必須です。

RowActions.FailureActionID

アクション・バインディング

N

行の処理時に不具合が発生した場合に起動するアクション・バインディングを指定します。

このプロパティの値はオプションです。

RowActions.InsertAfterRowActionID

アクション・バインディング

N

ADF表コンポーネントのUploadアクションを使用して、挿入される各行に対して起動するアクション・バインディングを指定します。このアクション・バインディングは、属性の設定後に起動されます。このプロパティはカスタム・アクションで使用するのが適切です。この場合、変数イテレータはメイン・イテレータとともに使用されます。

このプロパティの値はオプションです。

RowActions.InsertBeforeRowActionID

アクション・バインディング

N

Uploadコンポーネント・アクションを使用して、挿入される各行に対して起動するアクション・バインディングを指定します。指定したアクション・バインディングは、属性を設定する前に起動されます。

このプロパティの値はオプションです。

RowActions.InsertRowEnabled

Boolean

N

Trueに設定すると、ADF表コンポーネントに新しい行を挿入できます。デフォルト値はFalseです。

このプロパティをTrueに設定する場合は、RowActions.InsertBeforeRowActionIDの値を指定する必要があります。

通常、Fusion WebアプリケーションではCreateInsertアクション・バインディングを使用して新しい行の作成および挿入を行います。このシナリオでは、CreateInsertアクション・バインディングをInsertBeforeRowActionIDの値として指定します。

ADF表コンポーネントでの行の挿入の詳細は、「ADF表コンポーネントでの行の挿入」を参照してください。

RowActions.InsertRowsAfterUploadEnabled

Boolean

N

Trueに設定すると、前にアップロードされたかどうかにかかわらず、変更された行を再挿入できます。デフォルト値はFalseです。

InsertRowEnabledFalseに設定されている場合、このプロパティは無視されます。

RowActions.InsertTempRowActionID

アクション・バインディング

N

構成すると、このアクションが起動され、挿入行に対する行レベルのアクション・セットの実行中に、一時行が作成されます。

「表の列での行レベルのアクション・セットの使用」を参照してください。

RowActions.UpdateRowActionID

アクション・バインディング

N

各行を更新するために起動するアクション・バインディングを指定します。

このプロパティの値はオプションです。

RowActions.UpdateRowEnabled

Boolean

N

Trueに設定すると、既存の行を更新できます。デフォルト値はTrueです。

このプロパティの値は必須です。

RowData

Fusion Webアプリケーションでの複数のセッション間で統合Excelワークブックにデータをキャッシュする場合に、CachedAttributesプロパティの値を設定します。

ChangeIndicatorAttributeIDプロパティの値を設定して、Fusion Webアプリケーションからダウンロードした行が、それ以降に別のユーザーによって変更されたかどうかを判断します。

RowData.CachedAttributes

Array

N

この配列のプロパティの値を指定して、データがキャッシュされる属性を決定します。この配列の各CachedTreeAttribute要素では、次のプロパティがサポートされます。

  • Value

    データのキャッシュの対象となるツリー・バインディング属性を選択します。

  • Annotation

    このプロパティの詳細は、表A-1を参照してください。

RowDownSyncアクションは、構成されたRowData.CachedAttributesの行属性値をキャッシュします。表RowUpSyncUploadおよびUploadAllOrNothingアクションは、キャッシュされた行属性値をFusion Webアプリケーションに送信します。

注意: キャッシュされた属性値によって、列コンポーネントに公開されるのと同じ属性バインディングにエンド・ユーザーが行う編集がオーバーライドされます。したがって、同じ属性をCachedAttributesおよび表の列コンポーネントに構成しないでください。

キャッシュされた属性は、ユーザーがADF表コンポーネントの行を使用して実行するコピー・アンド・ペースト操作には含まれません。

RowData.CachedAttributes配列を使用したADF表コンポーネントへのデータのキャッシュの詳細は、「ADF表コンポーネントへのモデルドリブン・リスト・ピッカーの追加」および「ADF表の列へのカスタム・ポップアップ・ピッカー・ダイアログの追加方法」を参照してください。

RowData.ChangeIndicatorAttributeID

属性バインディング

Y

行固有のツリー属性バインディング値に評価されるEL式を指定します。属性値を使用して、統合Excelワークブックに最後にダウンロードした行が、それ以降別のユーザーによって変更されたかどうかを判断します。

「ワークブックからデータをアップロードする際のデータ競合の処理」を参照してください。

RowLimit

このプロパティ・グループでは、ADF表コンポーネントまたはADF読取り専用表コンポーネントでダウンロードおよび表示する行数を構成できます。

「表タイプ・コンポーネントがダウンロードする行数の制限」を参照してください。

RowLimit.Enabled

Boolean

N

Trueに設定すると、ダウンロードする行数がRowLimit.MaxRowsで設定した値に制限されます。デフォルト値はTrueです。

このプロパティの値は必須です。

RowLimit.MaxRows

Integer

Y

ダウンロードする最大行数に評価されるEL式を記述します。このコンポーネントは、Downloadアクションの起動時にEL式を評価します。デフォルト値は500です。MaxRowsが正の整数以外の場合、コンポーネントは可能なかぎり多くの行をダウンロードしようとします。ABCなどの無効な式は、-1(負の整数)として解釈されます。その結果、コンポーネントは可能なかぎり多くの行をダウンロードしようとします。

MaxRowsの値を0に設定すると、最初の0行をダウンロードするかどうかを尋ねるメッセージが表示されます。このメッセージが表示されないようにするには、MaxRows0以外の正の整数に設定します。

RowLimit.WarningMessage

String

Y

(オプション)ダウンロード可能な行数がRowLimit.MaxRowsで指定された数を超える場合にエンド・ユーザーに表示されるメッセージを生成するEL式を記述します。この式は、表のDownloadアクションが起動されるたびに評価されます。Excel 2007以上のバージョンのワークシートで対応できる最大行数は、約100万行です。このプロパティが空白のままの場合は、ADFデスクトップ統合に、「Too many rows available. Do you want to download the first {0} rows?」のようなメッセージが現在のカルチャー設定に応じて翻訳されて表示されます。

デフォルト値のかわりに使用する文字列キーを、カスタム・リソース・バンドルから指定できます。必要に応じて、デフォルトのメッセージと置き換えるカスタムのメッセージを指定することもできます。カスタム・メッセージには{0}が含まれている必要があります。{0}MaxRows値に置き換わります。

リソース・バンドルの詳細は、「統合Excelワークブックでのリソース・バンドルの使用」を参照してください。

TreeID

バインディング

N

現在のワークシートのページ定義ファイルからツリー・バインディングを指定します。行のダウンロードおよびアップロードが正しく機能するには、このプロパティの値を指定する必要があります。統合Excelワークブックのページ定義の要件の詳細は、表4-1を参照してください。

UniqueAttribute

属性バインディング

Y

一意の行固有のツリー属性バインディング値に評価されるEL式を指定します。この属性の値は、ADF表コンポーネントのDownloadアクション中に統合Excelワークブックにキャッシュされます。ADFデスクトップ統合は、所定のADF表コンポーネントの行のデータを設定または取得する前に、この値を使用して、ツリー・バインディングのイテレータが正しく配置されるようにします。

基礎となるツリー・バインディングのイテレータによってキー属性が公開されない場合にかぎり、この値を指定する必要があります。

次のいずれかの条件に該当する場合、この値はオプションです。

  • ツリー・バインディング・イテレータ内の行によって行キーが公開される場合。この場合、行キーの値がツリー・バインディング・イテレータの位置決めに使用されます。

    注意:

    単一属性キーまたは複数属性キーを公開するビュー・オブジェクトにツリーがバインドされるたびに、行キーが使用可能になります。
  • ADF表コンポーネントが挿入専用として構成されている(RowActions.InsertRowEnabledTrueRowActions.UpdateRowEnabledFalseに設定されている).場合。

ADF表コンポーネントの列プロパティ

表A-11に、TableColumn配列の列で使用できるプロパティを示します。

表A-11 ADF表コンポーネントの列プロパティ

名前 EL 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

CellStyleName

String

Y

列の各セルに適用されるExcelスタイル名に解決されるEL式を記述します。

Tooltip

String

Y

このプロパティの詳細は、表A-1を参照してください。

DynamicColumn

Boolean

N

Trueに設定すると、列が動的になります。デフォルト値はFalseです。動的な列の詳細は、「ADF表コンポーネントへの動的な列の追加」を参照してください。

HeaderLabel

String

Y

実行時に評価される場合、列ヘッダーにラベルを表示するEL式を記述します。

GroupedHeader

実行時に、ADF表コンポーネントの標準の表ヘッダー行の上部に追加の表ヘッダー行を表示することで、ADF表コンポーネントにレンダリングされる列をグループ化できるようにGroupHeaderプロパティを構成します。「ADF表コンポーネントでの列のグループ化」を参照してください。

GroupedHeader.Boundary

String

Y

startまたはendに設定して、グループ化されたヘッダーの開始列または終了列として列を指定します。動的な列のグループ化されたヘッダーを作成する場合は、startまたはendに評価されるEL式を記述します。

GroupedHeader.Label

String

Y

実行時に評価される場合、グループ化されるヘッダーにラベルを表示するEL式を記述します。

GroupedHeader.StyleName

String

Y

グループ化されるヘッダーの各セルに適用されるExcelスタイル名に解決されるEL式を記述します。

GroupedHeader.Tooltip

ツールチップ・プロパティの詳細は、表A-1を参照してください。

HeaderStyleName

String

Y

列ヘッダーの各セルに適用されるExcelスタイル名に解決されるEL式を記述します。

ID

String

N

列に名前を割り当てて、列とその目的を識別します。このプロパティに割り当てる値には、機能的な影響はありません。ただし、値を指定すること、および指定する値が列のリスト内で一意であることが必要です。ADF表コンポーネントの列の追跡に役立ちます。次のIDは、ADF表コンポーネントのデフォルトの列に予約されています。

  • _ADF_ChangedColumn

  • _ADF_FlagColumn

  • _ADF_RowKeyColumn

  • _ADF_StatusColumn

これらの列の詳細は、「ADF表コンポーネント内の特殊な列」を参照してください。

InsertComponent

ADFコンポーネント

N

挿入操作のために、バインディングを表すコンポーネントのプロパティを指定します。このコンポーネントは次のいずれかになります。

InsertUsesUpdateTrueの場合、ADF表コンポーネントはInsertComponentプロパティの値を無視します。通常、InsertComponentプロパティは滅多に使用しません。

InsertUsesUpdate

Boolean

N

挿入操作と更新操作で同じコンポーネント・タイプを使用する場合はTrueに設定します。Trueの場合、ADF表コンポーネントはInsertComponentプロパティの値を無視してUpdateComponentプロパティの値を読み取ります。

デフォルト値はTrueです。

ResizeMode

ResizeColumnsアクションが起動される場合に、ADFデスクトップ統合が実行時に列幅をどのように変更するかを指定します。

「実行時にデータに基づいて列をサイズ変更するためのADF表コンポーネントの構成」を参照してください。

TriggersRowRefresh

Boolean

Y

エンド・ユーザーがこの列の行セルを編集したときに行リフレッシュが自動的にトリガーされるように、Trueに設定するか、Trueに解決されるEL式を記述します。この機能を有効にするには、ADF表コンポーネントのRowActions.AutoRefreshRowEnabledプロパティをTrueに設定する必要もあります。

デフォルトでは、このプロパティに値は設定されていません。これは、Falseと同じです。

「ADF表コンポーネントの自動行リフレッシュの構成」を参照してください。

UpdateComponent

ADFコンポーネント

N

更新操作およびダウンロード操作のために、バインディングを表すコンポーネントのプロパティを指定します。このコンポーネントは次のいずれかになります。

Visible

Boolean

Y

TrueまたはFalseに解決されるEL式を記述します。Trueの場合、列はADF表コンポーネントに表示されます。Falseの場合、列は表示されません。デフォルト値はTrueです。

列を動的にする場合、ADF表コンポーネントはVisibleプロパティの値を無視します。動的な列の詳細は、「ADF表コンポーネントへの動的な列の追加」を参照してください。

Width

Double

Y

列の幅を文字数で指定します。列の幅を決定するための数値またはリテラル数値に評価されるEL式を指定できます。この値は、小数点を使用した小数値にすることができます。文字は幅の単位です。値は、ResizeModeSpecifiedWidthの場合に使用されます。

「実行時にデータに基づいて列をサイズ変更するためのADF表コンポーネントの構成」を参照してください。

ADF表コンポーネントのアクション

表A-12に、ADF表コンポーネントで使用できるコンポーネント・アクションを示します。

表A-12 ADF表コンポーネントのアクション

コンポーネント・アクション 説明

ClearCachedRowAttributes

ADF表コンポーネントの現在の行に対してキャッシュされた属性の値をクリアします。このアクションは、ADF表コンポーネントの列のDoubleClickActionSetのみで起動する必要があります。

DeleteFlaggedRows

ADF表コンポーネントのフラグ付けされた各行セットに対して指定のアクションを起動して、これらの行をADF表コンポーネントから削除します。

ActionsOptions.AbortOnFailureプロパティでは、DeleteFlaggedRowコンポーネント・アクションでエラーが発生した場合でも実行を続行するかどうかを決定できます。

「Fusion WebアプリケーションでのADF表コンポーネント行の削除」を参照してください。

DisplayRowErrors

ADF表コンポーネントの現在の行に関するエラー詳細がある場合は、これを表示します。このアクションは、ADF表コンポーネントで設定された列のアクションからのみ起動する必要があります。デフォルトでは、「ADF表コンポーネント内の特殊な列」_ADF_StatusColumnは、このアクションを起動するアクション・セットで構成されます。

DisplayTableErrors

バッチ処理中に発生したエラーのリストを表示します。このアクションは非推奨です。不要になっています。関連するすべてのエラー・メッセージは、「ステータス・ビューアを使用したエンド・ユーザーへのエラー・メッセージのレポート」で説明されているステータス・ビューアを使用して表示できます。

Download

TreeIDの現在の状態に相当する行をダウンロードします。TreeIDの詳細は、「ADF表コンポーネントのプロパティ」を参照してください。

DownloadFlaggedRows

フラグのある行をTreeIDで指定したツリー・バインディングからダウンロードします。TreeIDの詳細は、表A-10を参照してください。

このアクションはダウンロードされた行にのみ適用され、挿入された行は無視されます。「ワークブックからデータをアップロードする際のデータ競合の処理」を参照してください。

DownloadForInsert

このアクションは現在サポートされていません。「DownloadForInsertアクションに関する必知事項」を参照してください。

FlagAllRows

すべての行にフラグを設定します。

このアクションを起動すると、_ADF_FlagColumn列のすべての行にフラグ文字が設定されます。フラグ文字には次のプロパティがあります。

Character Code 25CF, Unicode(hex)

これは、黒丸として表示されます。

_ADF_FlagColumn列の詳細は、「ADF表コンポーネント内の特殊な列」を参照してください。

Initialize

このアクションは次のアクションを実行します。

  • ADF表コンポーネントからすべての行のデータを削除します。

  • ADF表コンポーネントの行から、キャッシュされた属性の値をクリアします。

  • プレースホルダ行を作成します。

  • ADF表コンポーネントにレンダリングする動的な列の数を再計算します。

  • 列ヘッダーを再描画します

統合Excelワークブックに保存されていない保留中の変更がADF表コンポーネントに含まれている場合は、このアクションの起動を取り消すことができるダイアログがエンド・ユーザーに対して表示されます。

MarkAllRowsChanged

表内のすべて行を_ADF_ChangeColumnで変更済とマークするには、このコンポーネント・アクションを指定します。

MarkAllRowsUnchanged

このコンポーネント・アクションを指定すると、_ADF_ChangedColumn列からすべてのフラグがクリアされます。

ResizeColumns

Table.ResizeColumnsModeおよびColumn.ResizeModeプロパティの値に応じて表の列をサイズ変更します。

「実行時にデータに基づいて列をサイズ変更するためのADF表コンポーネントの構成」を参照してください。

RowDownSync

現在のワークシート行に相当する、Fusion WebアプリケーションにあるADF表コンポーネントのイテレータの行のデータを、ワークシートと同期させます。このアクションは現在のワークシート行に作用するため、ADF表コンポーネントの列に関連付けられているDoubleClickActionSetのみにより、このアクションを起動する必要があります。

列のVisibleプロパティの値は、RowDownSyncの起動時にADF表コンポーネントによって評価および適用されません。列のCellStyleNameプロパティの値は、RowDownSyncの起動時にADF表コンポーネントによって評価および適用されます。列プロパティの詳細は、「ADF表コンポーネントの列プロパティ」を参照してください。

RowUpSync

ADF表コンポーネントがFusion Webアプリケーションを参照する現在のワークシート行の、保留中の変更を同期させます。RowUpSyncは現在のワークシート行に作用するため、ADF表コンポーネントの列に関連付けられているDoubleClickActionSetのみにより、このアクションを起動する必要があります。RowUpSyncを起動するDoubleClickActionSetは、さらに、Fusion WebアプリケーションにあるADF表コンポーネントのイテレータの位置を現在のワークシート行に変更します(イテレータがFusion Webアプリケーションに存在する場合)。

「表の列での行レベルのアクション・セットの使用」を参照してください。

RowUpSyncNoFail

障害を許容するRowUpSyncのバリアントです。RowUpSyncと同様、RowUpSyncNoFailは、行レベルのアクション・セットでの使用のみを対象にしています。「RowUpSyncNoFailを使用してADF表コンポーネントからの変更を同期化する方法」を参照してください。

UnflagAllRows

_ADF_FlagColumn列のセルからフラグを削除します。

_ADF_FlagColumnの詳細は、「ADF表コンポーネント内の特殊な列」を参照してください。

Upload

この表で変更済としてマークされたFusion Webアプリケーションのすべての行にアップロードします。

「ADF表コンポーネントからの変更のアップロード」を参照してください。

ExcelワークブックとFusion Webアプリケーションの間でのデータ競合の解決の詳細は、「ワークブックからデータをアップロードする際のデータ競合の処理」を参照してください。

UploadAllOrNothing

この表で変更済としてマークされたFusion Webアプリケーションのすべての行にアップロードします。どの行にも失敗がない場合にかぎり、正常な行をコミットします。

UploadAllOrNothingアクションの詳細は、「UploadAllOrNothingアクションを使用したADF表コンポーネントからの変更のアップロード」を参照してください。

ADF読取り専用表コンポーネントのプロパティおよびアクション

ADF読取り専用表コンポーネントでサポートされるTreeIDおよび他のプロパティ(ReadOnlyColumn配列の列で使用できるプロパティを含む)を示します。

ADF読取り専用表コンポーネントは、1つのアクション、Downloadを公開します。このアクションは、ADF読取り専用表のプロパティTreeIDで識別される表の現在の行をダウンロードします。

ADF読取り専用表コンポーネントの詳細は、「ADF読取り専用表コンポーネントの作成」を参照してください。

表A-13 ADF読取り専用表コンポーネントのプロパティ

名前 EL 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

Columns

Array

N

読取り専用列の配列を参照します。この配列の列がサポートできるプロパティの詳細は、表A-14を参照してください。

ComponentID

このプロパティの詳細は、表A-1を参照してください。

Position

このプロパティの詳細は、表A-1を参照してください。

RowLimit

このプロパティ・グループの詳細は、表A-10を参照してください。

TreeID

ツリー・バインディング

N

ADF読取り専用表コンポーネントがワークシートにツリー・バインディングを挿入して作成された場合、現在のワークシートに関連付けられているページ定義ファイルのツリー・バインディングIDを参照します。

表A-14に、ReadOnlyColumn配列の列で使用できるプロパティをアルファベット順に示します。

表A-14 ADF読取り専用表コンポーネントの列プロパティ

名前 EL 説明

Annotation

このプロパティの詳細は、表A-1を参照してください。

CellStyleName

String

Y

列の各セルに適用されるExcelスタイル名に解決されるEL式を記述します。

HeaderLabel

String

Y

列ヘッダーのラベルに解決されるEL式を記述します。

HeaderStyleName

String

Y

列ヘッダーの各セルに適用されるExcelスタイル名に解決されるEL式を記述します。

ID

String

N

列に名前を割り当てて、列とその目的を識別します。このプロパティに割り当てる値には、機能的な影響はありません。ただし、値を指定すること、および指定する値が列のリスト内で一意であることが必要です。ADF読取り専用表コンポーネントの列の追跡に役立ちます。

OutputText

ADFコンポーネント

このコンポーネントがサポートするプロパティの詳細は、「ADF出力テキスト・コンポーネントのプロパティ」を参照してください。

アクション・セットのプロパティ

アクション・セットに対して構成できるプロパティをアルファベット順に示します。

アクション・セットの詳細は、「アクション・セットの使用」を参照してください。

表A-15 アクション・セットのプロパティ

名前 EL 説明

ActionOptions

このプロパティ・グループは、ローカル・アクションとリモート・アクションを起動するためのオプションを指定します。

ActionOptions.AbortOnFailure

Boolean

N

Trueに設定した場合、1つのアクションが失敗すると、配列の残りのアクションは起動されません。Falseの場合、以前のアクションが成功したか失敗したかにかかわらず、すべてのアクションが起動されます。デフォルト値はTrueです。

ActionOptions.FailureActionID

アクション・バインディング

N

アクション・セットが正常に実行されない場合に起動するアクション・バインディングを指定します。たとえば、アクション・セットの起動が失敗したときに、加えられた変更をロールバックするアクション・バインディングを指定できます。

ActionOptions.NonBlocking

Boolean N

Trueに設定すると、関連付けられたActionSetの完了をユーザーが待っている間、このActionSetはユーザーによる他のExcelの機能の利用をブロックしません。デフォルト値は、Falseです。詳細は、「エンド・ユーザーがアクション・セットを実行しながらExcelの作業を続行できるようにする方法」を参照してください。

ActionOptions.SuccessActionID

アクション・バインディング

N

アクション・セットが正常に実行された場合に起動するアクション・バインディングを指定します。

このプロパティの値はオプションです。

Actions

Array

N

アクションの順序付きの配列を指定します。アクションは次のいずれかになります。

Alert

このプロパティ・グループは、アクション・セットが完了したことを示す、アラート形式のダイアログを表示するかどうか、またどのように表示するかを決定します。表示されるダイアログには、ユーザーがメッセージを確認してダイアログを終了できるボタンが1つあります。アラート・メッセージの表示方法は、「アクション・セットの起動後にアラートを発信する方法」を参照してください。

このグループのプロパティの多くは、EL式を使用してリソース・バンドルから文字列値を取得します。EL式の使用の詳細は、「統合Excelワークブックでのリソース・バンドルの使用」を参照してください。

Alert.Enabled

Boolean

N

Trueに設定すると、アクション・セットの操作が正常に完了した場合または1つ以上の失敗が発生した場合にエンド・ユーザーに通知する、アラート・メッセージが表示されます。

詳細は、「アクション・セットの起動後にアラートを発信する方法」を参照してください。

Alert.FailureMessage

String

Y

(オプション)アクション・セットの実行時にエラーが発生するとダイアログに表示されるメッセージに評価されるEL式を指定します。

Alert.OKButtonLabel

String

Y

(オプション)ダイアログの「OK」ボタンに表示されるメッセージに評価されるEL式を指定します。

Alert.SuccessMessage

String

Y

(オプション)アクション・セットの実行時にエラーが発生しなかった場合に、ダイアログに表示されるメッセージに評価されるEL式を指定します。

Alert.Title

String

Y

(オプション)ダイアログのタイトル領域に表示されるメッセージに評価されるEL式を指定します。

Annotation

Annotationの詳細は、表A-1を参照してください。

FailureMessage

String

Y

(オプション)アクションが失敗した場合にエンド・ユーザーに表示されるメッセージに、評価されるEL式を指定します。EL式を指定しないと、デフォルトのメッセージが表示されます。

詳細は、「アクション・セットのエラー処理の構成方法」を参照してください。

Status

このプロパティ・グループは、アクション・セットの実行時にステータス・メッセージを表示するかどうか、またどのように表示するかを決定します。ステータス・メッセージの表示方法は、「アクション・セットの実行中に進捗バーを表示する方法」を参照してください。

このグループのプロパティの多くは、リソース・バンドルで定義された文字列キーを参照するEL式を使用します。詳細は、「統合Excelワークブックでのリソース・バンドルの使用」を参照してください。

Status.AllowCancel

Boolean

N

Trueの場合は、「取消」ボタンがステータス・ダイアログ・ボックスに表示されます。

詳細は、「アクション・セットの実行中に進捗バーを表示する方法」を参照してください。

Status.Enabled

Boolean

N

True (デフォルト)の場合、アクション・セットの実行時にステータス・ウィンドウが表示されます。Falseの場合、ステータス・ウィンドウは表示されません。

Status.Message

String

Y

アクション・セットの実行中に、ステータス・ウィンドウで評価および表示するEL式を指定します。

Status.Title

String

Y

アクション・セットの実行中に、ステータス・ウィンドウのタイトル領域で評価および表示するEL式を指定します。

Status.Mode

String

N

進捗バーの表示形式を選択します。有効な値は、AutomaticBothBarsAlwaysMainBarOnlyDetailBarOnlyおよびMainMessageOnlyです。

Status.DetailStatusMessage

String

Y

関連するアクションの進捗として表示されるステータス・メッセージに評価されるオプションのEL式またはリテラル値を指定します。

確認アクションのプロパティ

表A-16に、アクション・セットのActionsの配列にあるConfirmationアクションがサポートするプロパティを、アルファベット順に示します。Actionsの配列およびアクション・セットが使用する他のプロパティの詳細は、表A-15を参照してください。

詳細は、「アクション・セット内の確認アクションの起動方法」を参照してください。

表A-16 確認アクションのプロパティ

名前 EL 説明

Annotation

(オプション) Annotationの詳細は、表A-1を参照してください。

CancelButtonLabel

String

Y

(オプション)実行時に「取消」ボタンで評価および表示されるEL式。デフォルトでは、値が指定されません。

OKButtonLabel

String

Y

(オプション)実行時に「OK」ボタンで評価および表示されるEL式。デフォルトでは、値が指定されません。

Prompt

String

Y

(オプション)実行時に確認のダイアログのメイン領域で評価および表示されるEL式。デフォルトでは、値が指定されません。

Title

String

Y

(オプション)実行時に確認のダイアログのタイトル領域で評価および表示されるEL式。デフォルトでは、値が指定されません。

ダイアログ・アクションのプロパティ

表A-17に、アクション・セットのActionsの配列にあるDialogアクションがサポートするプロパティを示します。Actionsの配列およびアクション・セットが使用する他のプロパティの詳細は、表A-15を参照してください。

表A-17のプロパティを使用してFusion WebアプリケーションからWebページを起動する方法は、「Fusion WebアプリケーションからのWebページの表示」を参照してください。

表A-17 ダイアログ・アクションのプロパティ

名前 EL 説明

Annotation

String

N

このプロパティの詳細は、表A-1を参照してください。

Page

String

N

アクションが起動するWebページを指定します。相対URLおよび絶対URLが有効な値です。

ShareFrame

Boolean

N

True (デフォルト)に設定すると、同じデータ・コントロール・フレーム内のDialog.Pageプロパティで指定されたWebページがExcelワークシートとして実行されます。絶対URLを指定した場合、ADFデスクトップ統合はDialog.ShareFrameプロパティの値を無視します。

Target

リスト

N

アクションが起動するWebページのレンダリングの状態を指定します。次のいずれかを選択します。

  • 埋込みWebブラウザ内のモーダルなダイアログにWebページをレンダリングするPopup

  • ランタイム作業ウィンドウにWebページをレンダリングするTaskPane

Title

String

Y

実行時にDialogのタイトルに解決されるEL式を記述するか、またはリテラル文字列を記述します。

WindowSize

Integer

N

表示されるダイアログの初期サイズをピクセルで指定します。有効な値の範囲は、0から2147483647です。指定された値が大きすぎるか小さすぎる場合は、実行時に適宜上方または下方修正されます。デフォルト値は、Height625Width600です。

ワークブックのアクションおよびプロパティ

ワークブックが起動できるアクションについて説明します。

これらのアクションを起動するためのリボン・コマンドの構成の詳細は、「実行時リボン・タブのワークブック・リボン・コマンドの定義方法」を参照してください。

表A-18 ワークブックのアクション

アクション 説明

Login

このアクションを起動すると、統合ExcelワークブックとFusion Webアプリケーションの間に新しいセッションが作成されます。

起動時にすでにセッションが確立されていた場合は、最初にLogoutアクションが内部的に起動して、そのセッションが解放されます。認証を強制するWebアプリケーションに対して実行されるワークブックの場合、Loginアクションは、エンド・ユーザーに対して有効なユーザー資格証明の提供を求めます。

「統合Excelワークブックの保護について」を参照してください。

Logout

起動するとADFデスクトップ統合によってFusion Webアプリケーションにリクエストが送信され、統合ExcelワークブックとFusion Webアプリケーションの間のセッションが無効になります。このアクションの起動後、エンド・ユーザーは、次に統合ExcelワークブックがFusion Webアプリケーションにアクセスする際に認証を受ける必要があります。

ClearAllData

このアクションが起動すると、ユーザーが入力したすべてのデータが、Oracle ADFバインディングを参照するセルからクリアされます。表(ADF表コンポーネントで作成された表など)は、ラベルがクリアされてヘッダー行のみが表示されるように切り捨てられます。入力テキスト・コンポーネントまたは出力テキスト・コンポーネントを参照するセルの値はクリアされます。列ヘッダーおよびラベルもクリアされます。統合Excelワークブックが使用するすべてのリソース・バンドルへの参照がクリアされます。バインディングを含まないワークシートやページ定義ファイルを参照しないワークシートは変更されません。ダイアログによって、エンド・ユーザーはこのアクションの起動の確認を求められます。エンド・ユーザーが起動を確認すると、ADFデスクトップ統合はアクションの起動後に次のイベントを実行します。

  • 統合ExcelワークブックのLogoutアクションを起動します。

  • ランタイム・セッションを終了して、統合Excelワークブックのすべてのデータとすべてのキャッシュをクリアします。

  • 統合Excelワークブックを再初期化して、ワークブックのLoginアクションを起動します。

ClearAllDataアクションを起動しても、Fusion Webアプリケーションでホストされるデータは変更されません。

EditOptions

このアクションを起動すると、エンド・ユーザーがWebAppRootプロパティの現在の値を確認し、新しい値を入力できるダイアログが起動されます。

エンド・ユーザーがWebAppRootの値を変更する場合、「OK」をクリックすると確認のダイアログが表示されます。変更を確認すると、次のイベントが発生します。

  • ワークブックのClearAllDataアクションが起動します。

  • ワークブックのLogoutアクションが起動します。

  • バインディングで参照されるワークブックのデータはすべて削除されます。

  • WebAppRootの参照は、Excelワークブックの構成で更新されます。

  • WebAppRootの値として指定されたFusion Webアプリケーションでユーザーを認証するために、ワークブックのLoginアクションが起動されます

ViewAboutDialog

このアクションを起動すると、BrandingItemsワークブック・プロパティで定義された情報および他の情報(サポートするソフトウェアのバージョンなど)を表示する「バージョン情報」ダイアログが起動します。ダイアログでは、エンド・ユーザーが診断レポートを生成したり、ログインしている場合は、ADFデスクトップ統合アドインのアップグレードをチェックしたりできます。「ADFデスクトップ統合診断レポートの生成」および「ローカル・システムのADFデスクトップ統合のアップグレード方法」を参照してください。

ToggleStatusViewer

起動すると、このアクションは、ステータス・ビューアをExcelの作業ウィンドウに表示または非表示にし、ステータス情報をエンド・ユーザーに表示します。エンド・ユーザーがクリックして、このアクションを起動するリボン・コマンドは、ステータス・ビューアを表示または非表示にします。「ステータス・ビューアを使用したエンド・ユーザーへのエラー・メッセージのレポート」を参照してください。

表A-19に、Excelワークブックで使用できるADFデスクトップ統合のプロパティをアルファベット順に示します。

表A-19 ワークブックのプロパティ

名前 EL 説明

ApplicationHomeFolder

String

N

デスクトップ統合プロジェクトを開発するJDeveloperアプリケーション作業領域(.jws)のルート・ディレクトリの絶対パスを指定します。パスは、Windowsの最大パス長である260文字未満にする必要があります。

たとえば、ADFデスクトップ統合のSummitサンプル・アプリケーションと統合されたワークブックのこのプロパティの値は、次のようになります。

D:\Oracle\Applications\Summit_ADFdi

最初に統合Excelワークブックを開くときに、ADFデスクトップ統合によって、このプロパティの値の指定が求められる場合があります。

「新しい統合Excelワークブックの構成方法」を参照してください。

AutoDisplayStatusViewerEnabled

Boolean

N

Trueに設定すると、エラーが発生した場合にステータス・ビューアが自動的に表示されます。ステータス・ビューアを表示する場合に、エンド・ユーザーがExcelリボンのステータス・ビューアのリボン・コマンドをクリックするように求めるには、Falseに設定にします。デフォルト値はTrueです。

「ステータス・ビューアを使用したエンド・ユーザーへのエラー・メッセージのレポート」を参照してください。

BrandingItems

Array

N

リテラル文字列またはELリソース式の名前と値の組合せの配列(例: #{res['myAppName']})。

統合Excelワークブックのブランディングの詳細は、「統合Excelワークブックのブランディング」を参照してください。

Compatibility

Array

N

特定の機能が含まれていない、異なるリリースのADFデスクトップ統合バージョンで作成されたワークブックが、別のリリースの動作を変更しないようにします。

互換性のプロパティの詳細は、「ADFデスクトップ統合互換性のプロパティ」を参照してください。

CustomizationEnabled

Boolean

N

ワークブックがカスタマイズ可能かどうかを指定します。Trueの場合、公開されたワークブックはそのメタデータをサーバーから取得します。これは実行時にカスタマイズできます。

カスタマイズの有効化の詳細は、「実行時のワークブック統合メタデータのカスタマイズ」を参照してください。

Login.WindowSize

Integer

N

表示されるログイン・ダイアログの初期サイズをピクセルで指定します。有効な値の範囲は、0から画面の幅または高さまでです。指定された値が大きすぎるか小さすぎる場合は、実行時に適宜上方または下方修正されます。デフォルト値は、Height625Width600です。

Parameters

Array

N

Fusion Webアプリケーションのページから統合Excelワークブックへパラメータを渡すために構成する、ワークブック・パラメータの配列。Fusion Webアプリケーションのページでは複数のワークブック・パラメータを定義できます。ページで定義するそれぞれのワークブック・パラメータ(URL引数を参照するパラメータ)は、この配列のParameterプロパティで指定する必要があり、指定しない場合は無視されます。

配列の各要素では、次のプロパティがサポートされます。

  • Annotation

    このプロパティの詳細は、表A-1を参照してください。

  • Parameter

    エンド・ユーザーがダウンロードする統合Excelワークブックの元の場所であるFusion Webアプリケーションのページで定義した、ワークブック・パラメータの名前を指定します。

このプロパティの使用の詳細は、「Fusion Webアプリケーションのページからワークブックへパラメータ値を渡す方法」を参照してください。

Project

String

N

現在のJDeveloper作業領域にあるJDeveloperプロジェクトの名前を指定します。ADFデスクトップ統合は、指定されたプロジェクトに相当する.jprファイルをロードしようとします。その.jprファイルが使用できない場合、または適切な形式でない場合は、エラーが表示されます。

設計モードで統合Excelワークブックを初めて開くと、ADFデスクトップ統合により親フォルダ階層で.jprファイルが検索されます。.jprファイルが検出されると、Projectの値がその.jprファイルに相当するプロジェクトの名前に設定されます。

ADFデスクトップ統合は、ApplicationHomeFolderで指定されたapplication_name.jwsファイルから、使用可能なプロジェクトの名前をロードします。

RemoteServletPath

String

N

ADFデスクトップ統合のリモート・サーブレットのパスを指定します。これは、WebAppRootに対して指定した値の相対パスにする必要があります。RemoteServletPathに指定する値は、Webアプリケーションのデプロイメント・ディスクリプタ・ファイル(web.xml)で指定する値と一致している必要があります。このプロパティのデフォルト値は次のとおりです。

/adfdiRemoteServlet

Resources

Array

N

ワークブックに登録するリソース・バンドルの配列を指定します。配列の各要素では、次のプロパティがサポートされます。

  • Alias

    Workbook.Resources内で一意の文字列値を指定します。EL式は、この文字列を使用してリソース・バンドルを参照します。

  • Annotation

    このプロパティの詳細は、表A-1を参照してください。

  • Class

    完全修飾クラス名を指定しますが、ファイル拡張子は含めません。指定するクラス名は、ワークブックを統合するFusion Webアプリケーションで使用するJavaリソース・バンドル・クラスになります。

    たとえば、ADFデスクトップ統合のSummitサンプル・アプリケーションのEditCustomers-DT.xlsxワークブックは次のリソース・バンドルを参照します。

    oracle.summitdi.resources.UIStrings
    

「統合Excelワークブックでのリソース・バンドルの使用」を参照してください。

Runtime Ribbon Tab

-

-

このプロパティ・グループは、実行時にリボン・タブをExcelに表示するかどうか、またどのように表示するかを定義します。この表の後続のエントリで、Runtime Ribbon Tabグループのプロパティを説明します。リボン・タブおよびそのコマンドの詳細は、「実行時リボン・タブの構成」を参照してください。

Runtime Ribbon Tab.Annotation

String

N

このプロパティの詳細は、「ADFデスクトップ統合で頻繁に使用するプロパティ」を参照してください。

Runtime Ribbon Tab.Visible

Boolean

N

Trueの場合、実行時にリボン・タブが表示されます。EnabledFalseに設定すると、リボン・タブは表示されません。デフォルト値はTrueです。

Runtime Ribbon Tab.Title

String

Y

タイトル領域に表示されるリボン・タブのタイトルに評価されるEL式を指定します。Excelでは、リボン・タブのタイトルの最大文字数は1024に設定されています。指定するEL式のランタイム値が1024文字を超えた場合、Excelでエラー・メッセージが生成されないように、ADFデスクトップ統合によって値が切り捨てられるため、この文字数を超えないようにしてください。

&文字を使用してキー・ヒントの文字を割り当てる場合、Runtime Ribbon Tab.Titleで文字Kを使用しないように検討してください。ワークブックがar_SAカルチャーで動作している場合、Excelではここで文字Kを使用できません。

Runtime Ribbon Tab.Workbook Commands

Array

N

この配列の各要素は、実行時のワークブックのコマンドに相当します。配列の各要素では、次のプロパティが使用されます。

  • Annotation

    このプロパティの詳細は、表A-1を参照してください。

  • Label

    このプロパティの詳細は、表A-1を参照してください。

    コマンド・ラベルに&文字を表示する場合は、&&を指定する必要があります。実行時、Excelでは単一の&文字は特殊文字として解釈され、&の次の文字がワークブック・コマンドのキーボード・アクセラレータとして割り当てられます。

  • Method

    ワークブックのリボン・コマンドが起動するワークブック・アクションを指定します。ワークブック・アクションの詳細は、表A-18を参照してください。

WebAppRoot

String

N

Fusion Webアプリケーションのルートの完全修飾URL。

WebPagesFolder

String

N

統合Excelワークブックで使用する予定のWebページを含むディレクトリのパスを指定します。パスに指定する値は、Windowsの最大パス長である260文字未満の、ApplicationHomeFolderの値の相対パスにする必要があります。

WorkbookID

String

N

統合Excelワークブックの一意の識別子。設計モードで初めてワークブックを開くと、ADFデスクトップ統合によって一意の識別子が生成されます。

この値は変更できません。ただし、「ワークブック・プロパティの編集」ダイアログの「WorkbookIDのリセット」リンクを使用すると、ADFデスクトップ統合で新しい値を生成できます。

「統合Excelワークブックのメタデータの整合性チェック」で説明しているように、このプロパティの値は改ざんチェック時に使用されます。

ワークシートのアクションおよびプロパティ

アクション・セットが起動できるワークシート・レベルのアクションと、Excelワークシートで使用できるADFデスクトップ統合のプロパティを示します。

「アクション・セットの使用」に説明されているアクション・セットでは、次のワークシートレベルのアクションを起動できます。

  • UpSync

    ワークシート内のADF入力テキスト・コンポーネントおよびADF値リスト・コンポーネントの保留中の変更を、Fusion Webアプリケーションに同期させます。

  • DownSync

    Fusion Webアプリケーションから、ワークシート内のADF入力テキスト、ADF出力テキストおよびADF値リストの各コンポーネントにデータ値をダウンロードします。

  • DisplayWorksheetErrors

    最新のアクション・セットの起動からのエラー・メッセージのリストを表示します。

    注意:

    このアクションは非推奨です。不要になっています。関連するすべてのエラー・メッセージは、「ステータス・ビューアを使用したエンド・ユーザーへのエラー・メッセージのレポート」で説明されているステータス・ビューアから表示できます。

アクション・バインディングまたはメソッド・アクション・バインディングを起動するようにリボン・コマンドを構成すると、実行時にユーザーがリボン・コマンドをクリックしたときに起動するユーザーアクション・セットが。デフォルトで次のように移入されます。

  1. UpSync

  2. リボン・コマンドに指定するアクションまたはメソッド・アクション・バインディング。

  3. DownSync

空のフォームを使用してワークシートで最初に起動するアクションがUpSyncワークシート・アクションの場合、エラーが発生する可能性があります。そのため、最初に起動するアクションは必ずDownSyncワークシート・アクションにしてください。最初にDownSyncワークシート・アクションを起動するには、リボン・コマンドのアクション・セットまたは表A-20で説明しているワークシート・イベント(StartupまたはActivate)のいずれかを構成します。

リボン・コマンドの構成の詳細は、「実行時リボン・タブの構成」を参照してください。

表A-20に、Excelワークシートで使用できるADFデスクトップ統合のプロパティを示します。

表A-20 ワークシートのプロパティ

名前 EL 説明

Annotation

String

N

このプロパティの詳細は、表A-1を参照してください。

CustomAttributePropertiesEnabled

Boolean

N

サーバー上のビュー・オブジェクトに定義したカスタム属性プロパティがEL式でサポートされるかどうかを指定します。

このプロパティのデフォルト値はFalseです。

「ADFデスクトップ統合ELベースのプロパティとカスタム属性プロパティの使用」を参照してください。

Events

Array

N

この配列の各要素は、関連付けられたワークシートのイベントが発生した場合に起動するアクション・セットを指定します。アクション・セットの詳細は、「アクション・セットのプロパティ」を参照してください。ワークシート・イベントの詳細は、この表のEvents.n.Eventのエントリを参照してください。

Events.nで始まるこの表の続くエントリは、この配列の要素がサポートするプロパティを示しています。nは、配列の特定の要素を指します。

Events.n.ActionSet

ActionSet

N

アクション・セットのプロパティの詳細は、「アクション・セットのプロパティ」を参照してください。

Events.n.InvokeOnceOnly

Boolean

N

このプロパティのデフォルト値はFalseです。

Trueに設定すると、このイベントに対するアクション・セットがワークシートによって起動されたかどうかに関する情報がワークブックに格納され、起動された場合は、ワークシートによるそのアクション・セットの2回目の起動が回避されます。ワークブックを保存しないとこの情報は失われます。つまり、次にワークブックを開いたときに、ワークシートによってイベントが再び起動されます。

Events.n.Annotation

String

N

Annotationプロパティの詳細は、表A-1を参照してください。

Events.n.Event

リスト

N

ワークシートでは、アクション・セットを起動するために構成できる、次のイベントがサポートされます。

  • Startup

    Excelワークブックが開き、ワークシートが初めて有効化されます。

  • Shutdown

    Excelワークブックが終了するか、またはExcelアプリケーションが終了します。

  • Activate

    ユーザーが現在のワークシートに移動します。

  • Deactivate

    ユーザーが現在のワークシートから離れるか、または停止イベントがトリガーされます。

ワークシート・イベントは、起動するアクション・セットが失敗した場合でも、実行を完了します。

ワークシート・イベントおよびアクション・セットの詳細は、「ワークシート・イベントからアクション・セットを起動する方法」を参照してください。

Protection.Mode

リスト

N

ワークシートでは次の2つのオプションが提供されます。

  • Off

    実行時にワークシートの保護が使用されません。

  • Automatic

    実行時にワークシートの保護が自動的に有効になります。

このプロパティのデフォルト値はOffです。

Protection.Password

String

N

エンド・ユーザーが実行時にシートの保護をオフにするのを防止するためのパスワードを指定します。Excelで許可される最大パスワード長は、255文字です。

Ribbon Commands

Array

N

実行時にワークシート・リボン・コマンドとして表示されるアクションを1つ以上指定します。各コマンドは、WorksheetMenuItem配列の要素です。この配列のエントリでは、次のプロパティがサポートされます。

  • Annotation

  • Image

    実行時にワークシートレベルのリボン・コマンドとして表示するイメージを指定します。ADFデスクトップ統合では、使用可能なイメージが用意されています。

  • Label

  • SelectActionSet

AnnotationおよびLabelプロパティの詳細は、表A-1を参照してください。SelectActionSetプロパティの詳細は、「アクション・セットのプロパティ」を参照してください。

コマンド・ラベルに&文字を表示する場合は、&&を指定する必要があります。実行時、Excelでは単一の&文字は特殊文字として解釈され、&の次の文字がワークシート・コマンドのキーボード・アクセラレータとして割り当てられます。

「実行時リボン・タブのワークシート・リボン・コマンドの構成方法」を参照してください。

Page Definition

String

N

ワークシートに関連付けるページ定義ファイルを指定します。ページ定義ファイルへの完全修飾パスは、Windowsの最大パス長である260文字未満にする必要があります。ページ定義ファイルの詳細は、「統合Excelワークブックのページ定義ファイルの使用」を参照してください。

Parameters

Array

N

このワークシートのページ定義ファイルで定義され、ここでワークブック・パラメータにバインドされるパラメータの配列。配列の各要素では、次のプロパティがサポートされます。

  • Annotation

    このプロパティの詳細は、表A-1を参照してください。

  • Parameter

    ワークシートに関連付けられているページ定義ファイルに追加したparameter要素のIDを指定します。

  • Value

    ワークブック・パラメータ(ワークブックのParameters.Parameterプロパティ)に対して指定したParameterプロパティの値を参照するEL式を記述します。

このプロパティの使用の詳細は、「Fusion Webアプリケーションのページからワークブックへパラメータ値を渡す方法」を参照してください。

RowData

Fusion Webアプリケーションでの複数のセッション間で統合Excelワークブックにデータをキャッシュする場合に、CachedAttributesプロパティの値を設定します。

ChangeIndicatorAttributeIDプロパティの値を設定して、Fusion Webアプリケーションからダウンロードした行が、それ以降別のユーザーによって変更されたかどうかを判断します。

「複数のWebセッション間における統合Excelワークブックの使用」を参照してください。

RowData.CachedAttributes

Array

N

この配列のプロパティの値を指定して、データがキャッシュされる属性を決定します。この配列の各CachedAttribute要素では、次のプロパティがサポートされます。

  • AttributeID

    このプロパティは、データがキャッシュされる属性バインディングを参照します。AttributeIDに関しては、属性バインディングを指定したり、同じワークシートのフォーム(たとえば、ADF入力テキスト・コンポーネント)で編集可能フィールドとして指定しないでください。

  • Annotation

    このプロパティの詳細は、表A-1を参照してください。

RowData.ChangeIndicatorAttributeID

バインディング

N

統合Excelワークブックに最後にダウンロードした行が、それ以降別のユーザーによって変更されたかどうかを判断するために使用する、ツリー・バインディングの行固有の属性を指定します。

「ワークブックからデータをアップロードする際のデータ競合の処理」を参照してください。

ServerContext

このプロパティ・グループは、現在のワークシートに表示される行を一意に識別する属性バインディングを参照するため、複数のセッション間でサーバー・データ・コンテキストを再確立することが可能になります。

「セッション間でのサーバー・データ・コンテキストのリストア」を参照してください。

ServerContext.CacheDataContexts

Array

N

サーバー・サイド・コンテキストを再確立する必要のあるバインディング・コンテナで複数のイテレータが定義されている場合に、CacheDataContexts配列に要素を追加します。CacheDataContexts配列では、ワークシートのキャッシュされたデータ・コンテキストを保存するために次のプロパティがサポートされます。

  • RestoreDataContextActionID

    起動するアクション・バインディングを参照します。

  • CachedServerContexts

    RestoreDataContextActionIDによって指定されるアクション・バインディングが起動する前にキャッシュおよび設定される属性バインディング値を識別する配列。CachedServerContext配列の各要素は、CachedAttributeIDプロパティおよびRestoredAttributeIDプロパティをサポートします。CachedAttributeIDは、ワークシートにキャッシュする属性バインディング値を識別します。RestoredAttributeIDは、宛先の属性バインディング値がソースの属性バインディング値と異なる場合に値を指定する、オプションのプロパティです。RestoredAttributeIDの値を指定しない場合、宛先の属性バインディング値としてCachedAttributeIDの値が使用され、その値はアクション・セットの起動前に設定されます。

  • Annotation

    このプロパティの詳細は、「ADFデスクトップ統合で頻繁に使用するプロパティ」を参照してください。

ServerContext.IDAttributeID

バインディング

N

現在のワークシートに表示される行を一意に識別する属性バインディングを指定します。このプロパティは、サーバー・コンテキストがワークシートの表以外のタイプのコンポーネントに対して適切に再確立されているかどうかを判断するために実行時に使用されます。

ServerContext.SendParameters

Boolean

N

このプロパティのデフォルト値はFalseです。

Trueに設定すると、複数のセッション間でコンテキストを再確立する際に、ワークブックによってこのワークシートの初期化パラメータが送信されます。

SetupActionID

バインディング

N

バインディング・コンテナ・メタデータが取得される前に、起動されるADFmActionバインディングを指定します。

このプロパティの値はオプションです。

2つ以上のワークシートで同じページ定義を使用している場合、最後のワークシートで指定されたアクション・バインディングが起動されます。そのため、ワークシートごとにページ定義を作成し、複数のワークシートに同じページ定義を指定しないようにします。

「明示的なワークシート設定アクションの使用」を参照してください。

Title

String

Y

文字列に解決され、ワークシートの名前を設定するEL式を記述します。設計時のEL式には長さの制限はなく、次の特殊文字を含めることができます。

[ ] \ / * ?

実行時に評価される文字列で表示できるのは最大31文字で、これらの特殊文字は無視されます。評価される文字列の長さが31文字を超える場合、余分な文字は切り捨てられ、表示されません。

Titleプロパティでは、EL式のバインディング部分をサポートしていません。リソース・タイプの式で使用されることを想定しています。

Titleプロパティ用に記述するEL式では、実行時に各ワークシートに対して一意の値が生成され、31文字未満になるようにしてください。

ADFデスクトップ統合互換性のプロパティ

製品の様々なリリースで、様々なADFデスクトップ統合機能が追加されています。互換性のプロパティにより、特定の機能が含まれていないADFデスクトップ統合バージョンで作成されたワークブックが、それらの動作を変更しないようにします。

表A-21に、ADFデスクトップ統合互換性のプロパティを示します。統合Excelワークブックの開発者が、これらのプロパティおよび関連付けられた機能を確認し、有効にするかどうかを判断する場合があります。統合Excelワークブックのこれらのプロパティにアクセスするには、「Oracle ADF」タブの「ワークブック」グループで、「ワークブック・プロパティ」をクリックして、「ワークブック・プロパティの編集」を表示し、「動作」および「互換性」プロパティを展開します。

表A-21 ADFデスクトップ統合互換性のプロパティ

名前 EL 説明

DataEntryValidationEnabled

Boolean

N

ADFデスクトップ統合でデータ入力の検証を実行するかどうかを指定します。

「統合Excelワークブックのデータ入力の検証の追加」を参照してください。

RejectExcelErrorsEnabled

Boolean

N

統合ExcelワークブックがFusion Webアプリケーションに送信するExcelセルのエラー値をADFデスクトップ統合が拒否するかどうかを指定します。デフォルト値はTrueです。

「統合Excelワークブックのデータ入力の検証の追加」を参照してください。

TableComponents.ModelDrivenColumns.DatePickerEnabled

Boolean

N

日付ピッカーをモデルドリブン列で使用できるかどうかを指定します。

「ADF入力日コンポーネントの挿入」および「ADF表コンポーネントへのModelDrivenColumnComponentサブコンポーネントの追加」を参照してください。

TableComponents.ModelDrivenColumns.InputListOfValuesPickerEnabled

Boolean

N

モデルドリブン列で既存のモデル・レイヤー・メタデータを利用して、ピッカー・ダイアログに「検索および選択」ユーザー・インタフェースを表示するかどうかを指定します。

「ADF表コンポーネントへのモデルドリブン・リスト・ピッカーの追加」を参照してください。

TableComponents.RowActionSetModelMgmtEnabled

Boolean

N

行レベルのアクション・セットでサーバー・サイド・モデルの状態を管理できるかどうかを指定します。

「表の列での行レベルのアクション・セットの使用」を参照してください。

TableComponents.SmartRowFailureReportingEnabled

Boolean

N

デフォルト値(True)では、ADF表コンポーネントUploadおよびDeleteFlaggedRowsアクションの拡張エラー・レポートを有効にします。