IPluginHostインターフェイス - automatic9045/TRS.MS-12 GitHub Wiki
アプリケーションとプラグインの間でやりとりするためのメソッド、プロパティを提供します。
public interface IPluginHost
基本情報
名前空間 TRS.TMS12.Interfaces
アセンブリ MS-12.PluginHost.dll
プロパティ
IDialog Dialog { get; }
アプリケーション独自のダイアログを表示する為のメソッドを提供する IDialog を取得します。
IPlugin> Plugins { get; }
List<アプリケーションでインスタンスを作成した IPlugin を取得します。
ITicketPlugin CurrentTicket { get; set; }
現在表示している券種を取得・設定します。
IPrinterPlugin CurrentPrinter { get; set; }
現在使用しているプリンターを取得・設定します。
bool IsOneTimeMode { get; set; }
現在一件操作中であるかを取得・設定します。
bool IsTestMode { get; set; }
現在営業試験中であるかを取得・設定します。
SendTypes? SendType { get; set; }
現在の操作種別を取得・設定します。
備考
null
を設定すると、3 連トグルボタンのいずれも押されていない状態になります。
TicketInfo>> AllSentTickets { get; }
List<List<アプリケーションを起動してからこれまでに発信された全ての TicketBase の TicketInfo のリストを取得します。
IssueReservableSendResult> ReservedTickets { get; }
List<一括一件操作において予約され、まだ発券されていない IssueReservableSendResult のリストを取得します。
イベント
ModeEnabledChangedEventHandler ModeEnabledChanged;
event各モードの有効・無効が変更されたときに発生します。
イベントの種類
ModeEnabledChangedEventHandler
SendTypeChangedEventHandler SendTypeChanged;
event操作種別が変更されたときに発生します。
イベントの種類
メソッド
void ThrowError(string text, string caption);
データ読込時にエラーを表示します。
エラーが一つでも発生した場合、パラメーターで設定したメッセージが表示され、ユーザーが実行しているデータの読込は強制的に中止されます。
パラメーター
text
string
表示するテキスト。
caption
string
エラーの概要を表すキャプション。
備考
- 実行中に障害メッセージを表示させるには IDialog.ShowError(string, bool) メソッドを使用して下さい。
警告表示のイメージ
void ThrowWarning(string text, string caption);
データ読込時に警告を表示します。
パラメーター
text
string
表示するテキスト。
caption
string
警告の概要を表すキャプション。
備考
- 実行中に警告を表示させるには IDialog.ShowWarning(string, bool) メソッドを使用して下さい。
void ThrowInformation(string text, string caption);
データ読込時に情報を表示します。
パラメーター
text
string
表示するテキスト。
caption
string
情報の概要を表すキャプション。
備考
- 実行中に情報を表示させるには IDialog.ShowInformation(string, bool) メソッドを使用して下さい。
KeyTab CreateKeyTabFromFile(string path, int keyCount = 60);
キーレイアウトを表現する List<KeyInfo> を XML ファイルから生成します。
パラメーター
path
string
XML ファイルのパス。
keyCount
int
ボタンの個数。
戻り値
キーレイアウトを表現する List<KeyInfo>。
void GoToSideMenu();
サイドメニューに画面を遷移します。