システム定義ボタン

この記事では、システム定義ボタンについて説明します。

概要

システム定義のいくつかのボタンが、アクション ウィンドウに自動的に存在します。 一般に、これらのシステム定義ボタンは、エンドユーザーに適用され、使用可能な状態を保持する必要があります。 ただし、まれなケースでは (たとえば、より専門的な管理が必要な場合、またはシステム定義ボタンが特定のフォームには役立たないまたは該当しない)、開発者は明確に抑制するまたはシステム定義ボタンを上書きする必要がある場合があります。 たとえば、ある状況では、複数の「新規」オプションからユーザーが選択できるようにするメニュー ボタンは、システム定義された新規ボタンの方が望ましい場合があります。

システム定義ボタンのリスト

次のテーブルは、システム定義ボタンの完全な一覧を示しています。 これらのテーブルは、条件付きまたは完全に抑制または上書きする必要がある場合に役立つ情報も提供します。

一般的なボタン

* システム定義のボタン名マクロは、SysSystemDefinedButtons マクロ ファイルにあります。

詳細フォームに固有のボタン

これらのボタンは、詳細フォームの経験の不可欠な部分です。 したがって、これらのボタンを非表示にする必要はほとんどありません。

* システム定義のボタン名マクロは、SysSystemDefinedButtons マクロ ファイルにあります。

システム定義ボタンのないフォーム スタイル

さまざまなフォーム スタイルについては、システム定義されたボタンの追加に意味がない主な理由は、これらのフォームが標準のアクション ウィンドウを持っていないことです。 次のフォーム スタイルは、システム定義のボタンを受け取ることはありません。

• ダッシュボード
• ダイアログ
• DropDialog
• FormPart
• ルックアップ
• サイトマップ
• ウィザード

システム定義のボタンの大部分またはすべてを非表示

フォーム上のシステム定義ボタンのほとんどまたはすべてを非表示にしている場合は、フォームのスタイル (Form.Design.Style) またはパターンを再確認し、フォームの目的を再検討する必要があります。 代わりにフォームをダイアログにすべきでしょうか。 (デフォルトでは、ダイアログにはシステム定義のボタンは表示されません。) 多くの場合、このような状況でのフォームはスタイル=自動であり、ダイアログとしてはより適切です。 フォームを技術的にダイアログにする必要がある場合、同時にすべてのシステム定義されたボタンを自動的に非表示にできるメタデータまたはコードは現在ありません。 フォームをシステム定義のボタンを受け取らないフォーム スタイルに切り替える場合を除き、各ボタンを個別に抑制/オーバーライドにする必要があります (この記事の他のセクションを参照)。 このシナリオは非常に稀です。

新規システムおよびシステムの削除のボタン

新規 および 削除 ボタンは、現在カーネルによって追加され、特殊なメタデータ プロパティを使用して制御されます。 これらのボタンは、常にフォーム上の最初のマスター データソースで機能します。

これらのボタンは既定ではいつ有効になりますか

フォームには通常、システム定義された新規および削除ボタンがあります。 これらのボタンは、次の条件でフォームに表示されます。

• フォームには、システム定義のボタンを使用できるスタイルがあります。
• フォームには 1 つ以上のデータ ソースがあります。

フォームの新規および削除ボタンの表示にどのように影響を与えますか。ただしキーボードのショートカットを介して標準の新規および削除タスクを起動できますか。

フォームでの 新規 ボタンと 削除 ボタンの表示/非表示を制御するには、Form.Design の ShowNewButton および ShowDeleteButton プロパティを使用します。 データ ソースでユーザーがまだレコードを作成して削除できる場合、キーボード ショートカットはシステム ボタンが表示されない場合でも引き続き機能することに注意してください。

新規および削除ボタンの状態 (有効/無効)、およびフォームで関連するタスクの動作にどのように影響しますか。

フォーム上の 新規 および 削除 ボタンの状態と、関連するタスクの動作の両方に影響を及ぼすには、AllowCreate と AllowDelete のプロパティを指定します。 また、このアプローチを使用して、新規と削除ボタンを無効にする場合、関連付けられているキーボード ショートカットは無効になります。

新しいタスク (ボタンをクリックするまたはキーボード ショートカットを使用するかのいずれか) の動作をどのように変更しますか。

新しいタスクの動作を変更するメカニズムは 3 つあります。

• 新しいレコード アクション プロパティを使用します。 このプロパティは、現在、Form.Design でのみ使用可能であり、フォーム上で New コマンドを呼び出すすべての CommandButton (セカンダリ コレクションにバインドされている CommandButtons も含まれる) に対して参照されたアクションがトリガーされます。 今後、新しいレコード アクション プロパティがすべてのコンテナー コントロールに配置され、プロパティのスコープにわたるコントロールが向上します。 現時点では、新しいレコード アクション プロパティもメニュー ボタンまたはドロップ ダイアログ ボタンとして定義できないことに注意してください。

  プロパティ	先頭値	説明
  Form.Design.NewRecordAction	フォームからのコントロール名	このプロパティは、指定されたアクションを実行するための新規タスクをオーバーライドします。

• (推奨)イベントを使用します。 特に、レコードの作成と削除の前後に実行することを意図したコードを配置できる場合、これらのアクションのプリイベントとポストイベントがあります。 以下のコード例をご覧ください。

  [Form]
  public class Form1 extends FormRun
  {
      public void init()
      {
          super();
          element.dataHelper().RecordCreating += eventhandler(this.PreRecordCreate);
          element.dataHelper().RecordCreated  += eventhandler(this.PostRecordCreate);
          // similar methods exist for deletion:
          // element.dataHelper().RecordDeleting, element.dataHelper().RecordDeleted
          //
          // explicit actions can be triggered via:
          // element.dataHelper().RecordCreate(), element.dataHelper().RecordDelete()        
      }
      public void PreRecordCreate(FormRunServiceArgs _cancellableArgs)
      {
          //  I can add my logic here that gets invoked before the global creation task
          // if I need to, I can cancel the "super" of the task by doing:
          // _cancellableArgs.cancel()
      }
      public void PostRecordCreate()
      {
          //  I can add my logic here that gets invoked after the global creation task
      }
  }
  

• 対応するデータ ソースの、create() または delete() メソッドで上書きを作成します。

新しいボタン (ただしタスクではない) の動作をどのように変更しますか。

システム定義された新規ボタンを、複数の「新規」オプションからユーザーに選択させるメニュー ボタンに置き変える場合を考えてみましょう。 したがって、次のタスクを実行できます。

1. システム定義された新規ボタンを非表示にします。
2. 新しいアクションに対する独自のボタンをモデル化します。

ただし、この時点で、キーボード ショートカットが呼び出されると、新規のシステム動作も起動します。 キーボード ショートカットを押したときにモデル化された新規ボタンを起動するようにするには、このボタンを Form.Design の NewRecordAction として設定する必要があります。 前のセクションで触れたように、アクションは現在フォーム上の新しいタスクを呼び出すすべての CommandButtons に対して起動されます。 したがって、このアプローチは、複数のデータソースを持つフォームでは使用しないでください。

編集、実行、保存、およびシステム ボタンを復元

編集、実行、保存、および 復元 ボタンでは、ユーザーが必要に応じてフォームの編集モードを切り替えることができます。 この機能は重要であるため、これらのボタンは現在抑制できません。 ただし、フォームが常に編集モードまたは表示モードである必要がある場合、ViewEditMode プロパティを使用して効果を達成でき、ボタンはフォームに表示されません。 ほとんどのフォームが ViewEditMode=Auto のままになることに注意してください。フォームが読み取り専用の場合、または常に編集可能になる場合を除いて、純粋に外観上の理由で ViewEditMode=View または ViewEditMode=Edit に設定しないでください。

条件付きで 編集ボタンを隠すまたは表示できますか？

あるポイントでフォームが編集可能で、他のポイントで読み取り専用にすると、ユーザーがフォームを編集できるかどうかを判断するロジックを使用して、実行時に ViewEditMode プロパティを設定できます。 フォームを読み取り専用にする必要があるときは、ViewEditMode=表示 を設定します。 フォームの編集または表示のいずれかができるとき、ViewEditMode=自動 を設定します。

編集ボタンをクリックするときに追加コードを実行するにはどうすればよいですか。

編集 ボタンをクリックしたときに追加のコードを実行させるには、イベントを使用します (この記事の前半の「新しいタスクの動作を変更する方法 (ボタンをクリックするか、キーボード ショートカットを使用する) は?」セクションの例を参照してください)。 具体的には、次のイベントを使用します。

• 現在の表示/編集モードの切替えをサブスクライブするには、次のイベントを使用します:
  • element.viewEditModeHelper().EditModeSwitching
  • element.viewEditModeHelper().EditModeSwitche
• 現在の表示/編集モードを照会するには、次のイベントを使用します:
  • element.viewEditModeHelper().isInEditMode()
  • element.viewEditModeHelper().IsInViewMode()
• 現在の表示/編集モードの切替えをトリガーするには、次のイベントを使用します:
  • element.viewEditModeHelper().setViewEditMode(ViewEditMode::Edit)

[更新]、[ポップアウト]、[閉じる] システム ボタン

更新、ポップアウト、および閉じる ボタンは、アクション ウィンドウの右側にあるシステム ボタンです。 更新 ボタンは、フォーム上のすべてのデータを更新するために使用されます。 ポップアウト ボタンを使用すると、現在のフォームが別のウィンドウに移動します。 閉じる ボタンは、フォームを閉じます (基本的に、このボタンはブラウザの 戻る ボタンをクリックします)。 これらのシステム ボタンは不可欠なコンポーネントであり、現時点では抑制することはできません。

他のシステム定義ボタン

残りのシステム定義のボタンは Form.Init 中に追加されます。 同じ名前のコントロールが存在しない場合にのみ追加されます。

システム定義されたボタンと共に追加コードを実行する、またはボタンの動作を変更するにはどうすればよいですか。

• 表示切り替えボタン (たとえば、グリッド ビュー、詳細ビュー、ヘッダービュー、または明細行ビューに切り替えるボタン) については、個々の TabPage で pageActivated() メソッドを上書きする必要があります。

• プリイベント/ポストイベントを持つシステム定義されたボタン (たとえば、新規、削除、および編集) については、適切なイベントにサブスクライブすることができます。 これらのボタンの特定のイベントについては、新規作成/削除 ボタンと 編集 ボタンの対応するセクションを参照してください。

• タスクを直接呼び出さないシステム定義のボタン (たとえば、SystemDefinedShowMenuButton および SystemDefinedShowListButton) については、registerOverrideMethod() の呼び出しを通してボタンの上書きを登録でき、システム定義ボタンをクリックしたときに追加コードが実行されるようにします。

  public void overrideFunction(FormCommandButtonControl _command)
      {
          // Put any pre-super code here 
          // This serves as the call to super()
          _command.clicked(); 
          // Put any post-super code here
      }
  

対応するタスクを抑制することなく、フォーム上のこれらのシステム定義されたボタンのいずれかを抑制するにはどうすればよいですか。

一般に、システム ボタンのいずれかを非表示にすることはお勧めしません。 それらの存在は、フォーム上のアクションに一貫性をもたらします。 ただし、それが役立たないある状況によっては、ボタンが現在表示されます。 これらの状況の多くに対処する将来の作業項目があります。 たとえば、次のタスクの作業項目があります。

• 添付ファイルを許可するように構成されていないフォームで 添付 ボタンを非表示にします。
• グリッドがないフォームで エクスポート ボタンを非表示にします。
• メイン グリッドがないフォームで フィルターを表示する ボタンを非表示にします。

ただし、これらのボタンのいずれかを抑制する必要がある場合 (決して推奨しません)、次のコード例に示すように、コードを通してコントロールを検索し、可視性を false に設定できます。 利用可能な場合、SysSystemDefinedButtons マクロを使用して、ボタン名を参照します。

FormCommandButtonControl attachButton;

    public void init()
    {
        #SysSystemDefinedButtons

        super();

        attachButton= this.control(this.controlId(#SystemDefinedAttachButton)) as FormCommandButtonControl; 
        attachButton.visible(false); 
    }