ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Application Development Frameworkデスクトップ統合開発者ガイド
11gリリース1(11.1.1.6.0)
B66694-01
  目次へ移動
目次
索引へ移動
索引

前
 
次
 

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

この付録では、ADFデスクトップ統合コンポーネントのプロパティのリストおよび説明を提供します。また、特定のコンポーネント(ADF入力テキスト、ADF出力テキスト、ADF値リスト、ADFボタン、ADF表、ワークブックおよびワークシートなど)によって公開されるアクションについて説明します。

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

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

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

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

名前 EL 説明

ActionSet


なし

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

Annotation

String

なし

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

ComponentID

String

なし

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

Label

String

あり

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

Position


なし

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

ReadOnly

Boolean

あり

このプロパティをTRUEに設定すると、ADFデスクトップ統合は、このプロパティを使用するコンポーネントを参照するセルにユーザーが加える変更を無視します。このプロパティは、Excelのワークブックやワークシートの保護機能とは関係ありません。ReadOnlyTRUEに設定すると、ユーザーはセルを変更できません。TRUEの場合、Oracle ADFコンポーネントを参照するセルの動作は次のようになります。

  • ADFデスクトップ統合は、ワークシートがリフレッシュされると、警告なしで変更を上書きします。

  • 統合ExcelワークブックがFusion Webアプリケーションと同期される際に、Fusion Webアプリケーションに変更は送信されません。

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

RowLimit



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

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

RowLimit.Enabled

Boolean

なし

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

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

RowLimit.MaxRows

Integer

あり

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

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

RowLimit.WarningMessage

String

あり

ダウンロード可能な行数がRowLimit.MaxRowsで指定された数を超える場合にエンド・ユーザーに表示されるメッセージを生成するEL式を記述します。コンポーネントは、Downloadアクションを起動するたびにこのEL式を評価します。Excel 2007以上のバージョンのワークシートで対応できる最大行数は、約100万行です。

RowLimit.WarningMessageのデフォルト値は次のとおりです。

#{_ADFDIres['ROWLIMIT_WARNINGS_MESSAGE_1']}

デフォルト値のかわりに使用する文字列キーを、カスタム・リソース・バンドルから指定できます。ダウンロード可能な行数を警告メッセージでエンド・ユーザーに知らせる場合は、リソース・バンドルの文字列キーに対して次のような値を記述します。

Too many rows available.Do you want to download the first {0} rows?

{0}は、実行時にRowLimit.MaxRowsの値を参照するプレースホルダです。

RowLimit.WarningMessageに対して、次のようなEL式を記述します。

#{res['stringkey']}

resは、カスタム・リソース・バンドルを表し、stringkeyは、カスタム・リソース・バンドルで定義する文字列キーを表します。リソース・バンドルの詳細は、10.2項「統合Excelワークブックでのリソース・バンドルの使用」を参照してください。

このプロパティの値がNULLの場合、Downloadアクションは、エンド・ユーザーにメッセージを表示せずにRowLimit.MaxRowsで指定した行数をダウンロードします。

StyleName

String

あり

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

Value

各種

あり

このプロパティは、ADF表コンポーネントのRowDownSyncアクションまたはワークシートのDownSyncアクションの起動後に評価されるEL式を参照します。結果の値は、通常、選択したコンポーネントに表示されるプライマリ値です。


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

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

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

名前 説明

Annotation

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

ComponentID

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

InputText.DoubleClickActionSet

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

InputText.ReadOnly

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

InputText.Value

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

Position

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

StyleName

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


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

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

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

名前 説明

Annotation

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

ComponentID

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

OutputText.DoubleClickActionSet

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

OutputText.Value

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

Position

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

StyleName

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


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

ADFラベル・コンポーネントは、実行時に静的な文字列値を表示します。ADFデスクトップ統合は、Labelプロパティが参照するEL式が評価されると値を生成します。ラベルの使用の詳細は、9.4項「統合Excelワークブックでのラベルの使用」を参照してください。

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

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

名前 説明

Annotation

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

ComponentID

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

Label

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

Position

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

StyleName

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


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

表A-5に、ADF値リスト・コンポーネントのプロパティを示します。ADF値リスト・コンポーネントの作成の詳細は、6.6項「ADF値リスト・コンポーネントの挿入」を参照してください。

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

名前 EL 説明

Annotation



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

ComponentID



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

ListOfValues.DependsOnListID

リスト・バインディング

なし

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

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

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

ListOfValues.ListID

リスト・バインディング

なし

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

ListOfValues.ReadOnly

Boolean

なし

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

Position



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

StyleName



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


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

TreeNodeListは、ADF表サブコンポーネントの1つで、実行時にADF表コンポーネントの列にドロップダウン・メニューをレンダリングします。ADF値リスト・コンポーネントと同じ機能をエンド・ユーザーに提供します。

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

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

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

名前 EL 説明

DependsOnList

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

あり

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

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

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

リスト

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

あり

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

ReadOnly

Boolean

あり

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


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

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

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

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

名前 EL 説明

DoubleClickActionSet



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

ReadOnly

Boolean

あり

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

Value

各種

あり

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


A.8 ADFボタン・コンポーネントのプロパティ

表A-8に、ADFボタン・コンポーネントのプロパティをアルファベット順に示します。

表A-8 ADFボタン・コンポーネントのプロパティ

名前 説明

Annotation

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

ClickActionSet

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

ComponentID

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

Label

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

LowerRightCorner

このプロパティはExcelセルの参照です。Positionと一緒に使用して、Excelワークシートでボタンが占有する領域を指定します。

Position

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


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

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

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

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

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

名前 EL 説明

Annotation



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

BatchOptions



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

BatchOptions.BatchSize

Integer

なし

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

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

BatchOptions.CommitBatchActionID

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

なし

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

BatchOptions.LimitBatchSize

Boolean

なし

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

BatchOptions.StartBatchActionID

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

なし

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

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

Columns



列の配列。配列の各列がサポートするプロパティの詳細は、A.9.2項「ADF表コンポーネントの列プロパティ」を参照してください。

ComponentID



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

Position



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

RowActions



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

RowActions.DeleteRowActionID

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

なし

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

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

RowActions.DeleteRowEnabled

Boolean

なし

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

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

RowActions.FailureActionID

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

なし

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

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

RowActions.InsertAfterRowActionID

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

なし

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

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

RowActions.InsertBeforeRowActionID

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

なし

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

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

RowActions.InsertRowEnabled

Boolean

なし

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

このプロパティをTRUEに設定した場合、次のプロパティの一方または両方の値を指定する必要があります。

  • RowActions.InsertAfterRowActionID

  • RowActions.InsertBeforeRowActionID

InsertAfterRowActionIDまたはInsertBeforeRowActionIDのどちらのプロパティに対して値を指定するかは、Fusion Webアプリケーションでの新しい行の作成方法で決まります。通常、Fusion WebアプリケーションではCreateInsertアクション・バインディングを使用して新しい行の作成および挿入を行います。このシナリオでは、CreateInsertアクション・バインディングをInsertBeforeRowActionIDの値として指定します。

ADF表コンポーネントでの行の挿入の詳細は、7.5項「データを挿入するためのADF表コンポーネントの構成」を参照してください。

RowActions.InsertRowsAfterUploadEnabled

Boolean

なし

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

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

RowActions.UpdateRowActionID

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

なし

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

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

RowActions.UpdateRowEnabled

Boolean

なし

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

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

RowData



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

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

RowData.CachedAttributes

Array

なし

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

  • Value

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

  • Annotation

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

RowData.CachedAttributes配列の要素に対して指定した属性バインディングに関しては、エンド・ユーザーが表示または編集できるようにコンポーネント(ADF表コンポーネントの列やADF入力テキスト・コンポーネントなど)を構成しないでください。RowData.CachedAttributes配列は、ワークシートのDownSyncアクションで取得された値をキャッシュします。ワークシートのUpSyncアクションは、RowData.CachedAttributes配列でキャッシュされた値をFusion Webアプリケーションに送信します。これは、ワークシートのコンポーネントを介して公開される属性バインディングに対してエンド・ユーザーが行った編集より優先されます。

RowData.CachedAttributes配列を使用したADF表コンポーネントへのデータのキャッシュの詳細は、8.5項「Webページ・ピッカー・ダイアログからのADF表列への値の挿入」を参照してください。

RowData.ChangeIndicatorAttributeID

バインディング

なし

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

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

RowLimit



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

TreeID

バインディング

なし

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

UniqueAttribute

属性バインディング

あり

TreeIDの値として指定したツリー・バインディングの属性を指定するEL式を記述します。この属性の値は、ADF表コンポーネントのDownloadアクションの起動時に統合Excelワークブックにキャッシュされます。ADFデスクトップ統合は、現在の行からデータを設定または取得する前に、この値を使用して、ツリー・バインディングのイテレータが正しく配置されるようにします。

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

  • ADF表コンポーネントが挿入専用として構成されている(RowActions.InsertRowEnabledTrueRowActions.UpdateRowEnabledFalseに設定されている)場合。

  • 基礎となるツリー・バインディングによってrowKeyが公開される場合(この場合、rowKeyは配置に使用されます)。

ツリー・バインディングのイテレータによってrowKeyが公開されない場合は、値を指定する必要があります。


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

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

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

名前 EL 説明

Annotation



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

CellStyleName

String

あり

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

DynamicColumn

Boolean

なし

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

HeaderLabel

String

あり

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

HeaderStyleName

String

あり

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

ID

String

なし

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

  • _ADF_ChangedColumn

  • _ADF_FlagColumn

  • _ADF_StatusColumn

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

InsertComponent

ADFコンポーネント

なし

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

InsertUsesUpdateTrueの場合、ADF表コンポーネントはInsertComponentプロパティの値を無視します。

InsertUsesUpdate

Boolean

なし

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

デフォルト値はTrueです。

UpdateComponent

ADFコンポーネント

なし

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

Visible

Boolean

あり

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

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


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

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

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

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

ClearCachedRowAttributes

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

DeleteFlaggedRows

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

詳細は、7.9項「Fusion Webアプリケーションで行を削除するためのADF表コンポーネントの構成」を参照してください。

DisplayRowErrors

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

DisplayTableErrors

エラーがある場合に、ADF表コンポーネントのメッセージ・ダイアログに、詳細なエラー・リストを表示します。このアクションを、ADF表コンポーネントで設定された列のアクションから起動しないでください。かわりに、ADFボタン、ADF出力テキスト・コンポーネントまたはワークシート・リボン・ボタンに対してアクション・セットを構成して、このアクションを起動します。

Download

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

DownloadFlaggedRows

TreeID内で使用可能な現在の項目セットに相当するフラグ付けされた行をダウンロードします。TreeIDの詳細は、表A-9を参照してください。

DownloadForInsert

このアクションを起動すると、Fusion WebアプリケーションからADF表コンポーネントへ行がダウンロードされ、各行が保留中の挿入として扱われます。

同じアクション・セット内でDownloadおよびDownloadForInsertをアクションとして指定しないでください。これらのアクションのうち、アクション・セットで起動される最後のアクションよって、ADF表コンポーネントに表示されるデータが決まります。

DownloadForInsertアクションでダウンロードするすべての行を変更済としてマーク付けするアクション・セットでは、次に起動するコンポーネント・アクションとしてMarkAllRowsChangedコンポーネント・アクションを指定します。

ADF表コンポーネントのRowActions.InsertRowEnabledプロパティがFalseに設定されている場合、アクション・セットから起動されたDownloadForInsertアクションは無視されます。DownloadForInsertアクションが正しく起動するように、RowActions.InsertRowEnabledTrueに設定します。

詳細は、7.7項「ADF表コンポーネントに挿入前のデータをダウンロードするためのワークシートの構成」および15.2項「セッション間でのサーバー・データ・コンテキストのリストア」を参照してください。

FlagAllRows

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

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

Character Code 25CF, Unicode(hex)

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

_ADF_FlagColumn列の詳細は、7.10.2項「ADF表コンポーネントでの行のフラグ付け」および7.11項「ADF表コンポーネント内の特殊な列」を参照してください。

Initialize

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

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

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

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

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

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

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

MarkAllRowsChanged

DownloadForInsertコンポーネント・アクションでダウンロードされるすべての行を_ADF_ChangedColumn列で変更済としてマーク付けする場合は、アクション・セットでDownloadForInsertコンポーネント・アクションを起動した後、起動するコンポーネント・アクションとしてMarkAllRowsChangedコンポーネント・アクションを指定します。

MarkAllRowsUnchanged

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

RowDownSync

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

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

RowUpSync

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

UnflagAllRows

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

_ADF_FlagColumnの詳細は、7.10.2項「ADF表コンポーネントでの行のフラグ付け」および7.11項「ADF表コンポーネント内の特殊な列」を参照してください。

Upload

保留中の変更をFusion Webアプリケーションにアップロードします。

詳細は、7.8項「ADF表コンポーネントから変更をアップロードするためのOracle ADFコンポーネントの構成」を参照してください。

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


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

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

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

名前 EL 説明

Annotation



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

Columns

Array

なし

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

ComponentID



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

Position



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

RowLimit



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

TreeID

ツリー・バインディング

なし

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


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

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

名前 EL 説明

Annotation



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

CellStyleName

String

あり

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

HeaderLabel

String

あり

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

HeaderStyleName

String

あり

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

ID

String

なし

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

OutputText

ADFコンポーネント


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


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

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

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

名前 EL 説明

ActionOptions



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

ActionOptions.AbortOnFailure 

Boolean

なし

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

ActionOptions.FailureActionID

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

なし

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

ActionOptions.SuccessActionID

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

なし

アクション・セットが正常に実行された場合に起動するアクション・バインディングを指定します。たとえば、commitアクションを実行するアクション・バインディングを指定できます。このプロパティの値はオプションです。

Actions

Array

なし

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

Alert



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

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

Alert.Enabled

Boolean

なし

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

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

Alert.FailureMessage

String

あり

アクション・セットの実行時にエラーが発生するとダイアログに表示されるメッセージに評価されるEL式を指定します。デフォルトのEL式は次のとおりです。

#{_ADFDIres['DIALOGS_ACTION_ALERT_FAILURE_PROMPT']}

Alert.OKButtonLabel

String

あり

ダイアログの「OK」ボタンに表示されるメッセージに評価されるEL式を指定します。デフォルトのEL式は次のとおりです。

#{_ADFDIres['DIALOGS_OK_BUTTON_LABEL']}

Alert.SuccessMessage

String

あり

アクション・セットの実行時にエラーが発生しなかった場合に、ダイアログに表示されるメッセージに評価されるEL式を指定します。デフォルトのEL式は次のとおりです。

#{_ADFDIres['DIALOGS_ACTION_ALERT_SUCCESS_PROMPT']}

Alert.Title

String

あり

ダイアログのタイトル領域に表示されるメッセージに評価されるEL式を指定します。デフォルトのEL式は次のとおりです。

#{_ADFDIres['DIALOGS_ACTION_TITLE']}

Annotation



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

Status



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

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

Status.Enabled

Boolean

なし

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

Status.Message

String

あり

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

#{_ADFDIres['STATUS_MESSAGE_PROMPT']}

Status.Title

String

あり

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

#{_ADFDIres['DIALOGS_ACTION_TITLE']}

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

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

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

名前 EL 説明

Annotation



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

CancelButtonLabel

String

あり

実行時に「取消」ボタンで評価および表示されるEL式。デフォルト値は次のとおりです。

#{_ADFDIres['DIALOGS_CANCEL_BUTTON_LABEL']}

OKButtonLabel

String

あり

実行時に「OK」ボタンで評価および表示されるEL式。デフォルト値は次のとおりです。

#{_ADFDIres['DIALOGS_OK_BUTTON_LABEL']}

Prompt

String

あり

実行時に確認のダイアログのメイン領域で評価および表示されるEL式。デフォルト値は次のとおりです。

#{_ADFDIres['DIALOGS_ACTION_CONFIRM_PROMPT']}

Title

String

あり

実行時に確認のダイアログのタイトル領域で評価および表示されるEL式。デフォルト値は次のとおりです。

#{_ADFDIres['DIALOGS_ACTION_TITLE']}

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

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

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

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

名前 EL 説明

Annotation

String

なし

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

Page

String

なし

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

ShareFrame

Boolean

なし

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

Target

リスト

なし

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

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

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

Title

String

あり

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

WindowSize

Integer

なし

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


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

表A-17に、ワークブックで起動できるアクションを示します。これらのアクションを起動するためのリボン・ボタンの構成の詳細は、8.3.1項「実行時リボン・タブのワークブック・コマンド・ボタンの構成方法」を参照してください。

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

アクション 説明

Login

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

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

Logout

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

ClearAllData

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

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

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

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

ClearAllDataアクションを起動しても、Fusion Webアプリケーションでホストされるデータは変更されません。Fusion Webアプリケーションでホストされるデータを変更するには、次のアクションを1つ以上起動する必要があります。

  • ワークシートのUpSyncアクション

    このアクションは、表以外のタイプのコンポーネントで参照されるすべてのデータを同期させます。詳細は、A.13項「ワークシートのアクションおよびプロパティ」を参照してください。

  • ADF表コンポーネントのRowUpSyncアクションを使用して、行の保留中の変更をFusion Webアプリケーションと同期させることができます。ADF表コンポーネントのDeleteFlaggedRowsアクションを起動すると、フラグ付きの行を削除できます。ADF表コンポーネントのアクションの詳細は、A.9.3項「ADF表コンポーネントのアクション」を参照してください。

EditOptions

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

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

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

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

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

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

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

    ClearAllDataワークブック・アクションは、統合Excelワークブックで参照されるすべてのリソース・バンドルをクリアします。WebAppRootが変更されると、統合Excelワークブックは、再初期化プロセスの中でFusion Webアプリケーションからリソース・バンドルを取得しようとします。このFusion Webアプリケーションへのリクエストにより、認証プロセスがトリガーされます。

ViewAboutDialog

このアクションを起動すると、BrandingItemsワークブック・プロパティで定義された情報および他の情報(サポートするソフトウェアのバージョンなど)を表示する「バージョン情報」ダイアログが起動します。


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

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

名前 EL 説明

ApplicationHomeFolder

String

なし

デスクトップ統合プロジェクトを開発するJDeveloperアプリケーション作業領域(.jws)のルート・ディレクトリの絶対パスを指定します。

たとえば、Master Price Listモジュールと統合するワークブックのこのプロパティの値は、次のようになります。

C:\FusionOrderDemo\MasterPriceList

­最初に統合Excelワークブックを開くときに、ADFデスクトップ統合によって、このプロパティの値の指定が求められます。値の指定を求めるダイアログで「取消」をクリックすると、ApplicationHomeFolderの値は自動的にExcelワークブックを含むディレクトリに設定されます。

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

BrandingItems

Array

なし

リソース・バンドル参照に解決される名前と値のペアの配列(#{res['myAppName']}など)、またはリテラル文字列。配列の各ペアは、名前と値で構成されます。各名前と値は、リテラル文字列またはEL式を参照できます。

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

Login.WindowSize

Integer

なし

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

Parameters

Array

なし

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

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

  • Annotation

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

  • Parameter

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

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

Project

String

なし

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

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

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

RemoteServletPath

String

なし

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

/adfdiRemoteServlet

Resources

Array

なし

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

  • Alias

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

  • Annotation

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

  • Class

    完全修飾クラス名を指定します。指定するクラス名は、ワークブックを統合するFusion Webアプリケーションで使用するJavaリソース・バンドル・クラスになります。たとえば、Master Price ListモジュールのEditPriceList-DT.xlsxワークブックは、次のリソース・バンドルを参照します。

    oracle.fodemo.masterpricelist.resources.UIStrings
    

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

Runtime Ribbon Tab

-

-

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

Runtime Ribbon Tab.Annotation

String

なし

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

Runtime Ribbon Tab.Visible

Boolean

なし

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

Runtime Ribbon Tab.Title

String

あり

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

Runtime Ribbon Tab.Workbook Commands

Array

なし

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

  • Annotation

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

  • Label

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

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

  • Method

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

WebAppRoot

String

なし

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

WebPagesFolder

String

なし

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

WorbookID

String

なし

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

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

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


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

ADFデスクトップ統合のExcelワークシートでは、次のアクションを起動できます。

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

  1. UpSync

  2. ADFボタン・コンポーネントに指定するアクション・バインディングまたはメソッド・アクション・バインディング

  3. DownSync

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

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

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

名前 EL 説明

Annotation

String

なし

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

Events

Array

なし

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

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

Events.n.ActionSet

ActionSet

なし

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

Events.n.InvokeOnceOnly

Boolean

なし

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

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

Events.n.Annotation

String

なし

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

Events.n.Event

リスト

なし

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

  • Startup

    Excelが起動します。

  • Shutdown

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

  • アクティブ化

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

  • Deactivate

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

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

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

Protection.Mode

リスト

なし

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

  • Off

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

  • Automatic

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

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

Protection.Password

String

なし

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

Ribbon Commands

Array

なし

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

  • Annotation

  • Label

  • SelectActionSet

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

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

Page Definition

String

なし

ワークシートに関連付けるページ定義ファイルを指定します。ページ定義ファイルの詳細は、4.3項「統合Excelワークブックのページ定義ファイルの使用」を参照してください。

Parameters

Array

なし

ワークブックのParametersプロパティから統合Excelワークブックのワークシートへパラメータを渡すために構成する、ワークシート・パラメータの配列。配列の各要素では、次のプロパティがサポートされます。

  • Annotation

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

  • Parameter

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

  • Value

    ワークブック初期化パラメータ(ワークブックのParameters.Parameterプロパティ)に対して指定したParameterプロパティの値を参照するEL式を記述します。このワークシートに関連付けられているページ定義ファイルが初めて初期化されるときに、ワークブックのParameters.Parameterプロパティによってこの値が提供されます。

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

RowData



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

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

RowData.CachedAttributes

Array

なし

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

  • AttributeID

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

  • Annotation

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

キャッシュされた属性の値のクリアの詳細は、7.18項「ADF表コンポーネントでのキャッシュされた属性値のクリア」を参照してください。

RowData.ChangeIndicatorAttributeID

バインディング

なし

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

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

ServerContext



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

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

ServerContext.CacheDataContexts

Array

なし

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

  • RestoreDataContextActionID

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

  • CachedServerContexts

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

  • Annotation

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

ServerContext.IDAttributeID

バインディング

なし

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

ServerContext.SendParameters

Boolean

なし

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

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

Title

String

あり

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

[ ] \ / * ?

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

Titleプロパティ用に記述するEL式では、実行時に各ワークシートに対して一意の値が生成され、31文字以下になるようにしてください。たとえば、EL式によって生成される統合ワークシートのTitleプロパティの値が既存のワークシートの名前と一致すると、エラーが発生します。