メインコンテンツまでスキップ

IViewDefinitions.RegisterGetStyleCallback(IElementDef,Func<IEditorElement, IModel, IStyleProperty, object>,StyleAttributes) メソッド

名前空間: NextDesign.Core

説明

スタイル属性を指定して、指定されたエディタ要素定義より生成されるエディタ要素のスタイル値取得コールバック関数を登録します。
・エクステンションのActivate時に呼び出すことを推奨します。
・スタイル値は以下の優先順位で取得されます。
 1. スタイル値取得のコールバック関数値
 2. ビューインスタンスで設定されているスタイル値
 3. ビュー定義で定義されているスタイル値
・タイトルテキストの文字色を変更する場合は、当メソッドのコールバック関数にての文字色を再定義します。
・登録したコールバック関数が呼び出される契機は以下です。
 ・エディタ要素が表示された
 ・エディタ要素が参照するモデルのフィールド値が変更された

引数

名前説明
elementDefIElementDefエディタ要素定義
getterFunc<IEditorElement, IModel, IStyleProperty, object>スタイル値取得のコールバック関数

コールバック関数仕様
object get_styleFunction(IEditorElement element, IModel model, IStyleProperty target)

- 引数
- element : IEditorElement ・・・スタイル適用対象のエディタ要素が引き渡されます
- model : IModel ・・・タイル適用対象のエディタ要素が参照するモデルが引き渡されます
- target : IStyleProperty ・・・対象スタイル属性情報が引き渡されます
- 返値
- object ・・・ Getの結果として扱うオブジェクトを返します
- コールバック関数が指定された対象スタイル属性の型に合致するオブジェクトでなければなりません
- 型に合致しないオブジェクトを戻した場合、特に例外とはならずIStyleProperty.CurrentValueの値に自動変換されます
- 例外の扱い
- コールバック関数の実装で例外をスローした場合、その例外は捕捉されて、コールバックの呼び出し結果としてIStyleProperty.CurrentValueの値が使用されます
propertiesStyleAttributesスタイル属性
(複数のスタイル属性名が指定された場合、それぞれについてコールバック登録行う)

戻り値

  • void

例外

名前例外クラス説明
キーが重複ExtensionDuplicationExceptionコールバック登録キーが重複する場合