code (Domino DTD)

包含階層

包含元: <action>、<agent>、 <area>、<actionhotspot>、<appletparameters>、<appletresource>、<button>、<bordercaption>、 <column>、 <computedtext>、<databasescript>、 <embeddedview>、<embeddednavigator>、<field>、 <folder>、<form>、<frameset>、<globals>、<imageref>、<javaapplet>、<page>、 <pardef>、<picture>、<popup>、 <scriptlibrary>、 <section>、<sectiontitle>、<subform>、<subformref>、<view>、%link.computed.content;

包含要素: %code.types;

構文

<!ELEMENT code ( %code.types; )>

[コンテンツ]

%code.types;

%code.types; エンティティのコーディング言語オプション (<formula>、<lotusscript>、<javaproject>、<simpleaction>、および <javascript> の各要素) のいずれかが含まれます。

属性

<!ATTLIST code

>

enabled

Boolean 型。Notes のユーザーインターフェースで、例えば段落の非表示式で、コードを有効にするためにチェックボックスを選択するオプションがないような場面でのみ適用されます。コードが有効なとき、デフォルトで true に設定されます。

event

組み込みイベントまたはユーザー定義の LotusScript 関数の名前です。

for

%code.for.tokens; エンティティのキーワードのリストです。この属性は、Web と Notes クライアントによる実行がどちらも可能であるようなインスタンスで、コードを実行する場所を指定します。

<code> 要素の定義済みエンティティ

%code.databasescript.lotusscript.or.formula.events; エンティティは、databasescript を介して LotusScript または式言語のコードをトリガーするイベントの種類のリストを表します。このエンティティは、 %code.lotusscript.or.formula.events; エンティティで使用されます。

構文:

<!ENTITY % code.databasescript.lotusscript.or.formula.events "querydocumentdelete | querydocumentundelete| postdocumentdelete | querydroptoarchive| postdroptoarchive ">

%code.events; エンティティは、コードの実行をトリガーするイベントの種類のリストを表します。

構文:

<!ENTITY % code.events "%code.formula.events; | %code.lotusscript.events;| %code.lotusscript.or.formula.events; | %code.javascript.events; ">

%code.for.tokens; エンティティは、for 属性のキーワードトークンオプションのリストを表します。これらのキーワードトークンは、コードを Web または Notes クライアントで使用する予定があるかどうかを示します。Domino Designer で Web または Notes クライアントのどちらかでトリガーできるコードを作成可能なイベントでのみ、この属性を指定する必要があります。そのようなイベントでは、デフォルトは web です。

構文:

<!ENTITY % code.for.tokens "web | client ">

%code.formula.events; エンティティは、式言語コードの実行をトリガーする複数のイベントのリストを表します。このエンティティは %code.events; エンティティで使用されます。

構文:

<!ENTITY % code.formula.events "defaultvalue | inputtranslation | inputvalidation | windowtitle | webqueryopen | webquerysave | hidewhen | value | selection | htmlattributes | htmlhead | htmlbody | targetframe | helprequest | form | alternatehtml | showsinglecategory | label | displayvalue ">

alternatehtml

ユーザーのブラウザではコードを実行できない場合に表示する代替テキストです。例えば、ユーザーのブラウザで Java アプレットを実行できない場合、このテキストでそのアプレットについて説明し、このブラウザではそれを実行する機能がサポートされていないことをユーザーに通知します。

defaultvalue

フィールドの初期値を指定します。

displayvalue

アクションチェックボックスに表示する値を指定します。

form

ビューから開くフォームを定義します。

helprequest

[ヘルプ] が選択されたときに実行します。

hidewhen

指定した式が true の場合にオブジェクトを非表示にします。

htmlattributes

関連付けられている HTML オブジェクトの特性を指定します。フィールドに適用されます。

htmlbody

オブジェクトの HTML Body タグに記述された情報です。フォームとページに適用されます。

htmlhead

オブジェクトの HTML Head タグに記述された情報です。フォームとページに適用されます。

inputtranslation

フィールドに入力されたデータを変換して、指定されたフォーマットに適合するようにします。

inputvalidation

フィールドに入力されたデータが、指定した条件を満たしているかどうかを確認します。

label

アクションボタンに表示するラベルを指定します。

selection

ビューに表示する文書を選択します。

showsinglecategory

埋め込みビューで、あるカテゴリに含まれる文書だけがビューに表示されるように制限します。このカテゴリは、式またはテキストで定義します。

targetframe

コマンド実行結果を表示するフレームセット内のフレームを定義します。

value

計算フィールドの内容を指定します。

webqueryopen

Web 文書を表示前に実行します。

webquerysave

Web 文書を保存前に実行します。

windowtitle

フォームを使用する文書のタイトルバーに表示されるテキストを生成します。

%code.javascript.events; エンティティは、JavaScript コードの実行をトリガーする複数のイベントのリストを表します。このエンティティは %code.events; エンティティで使用されます。

構文:

<!ENTITY % code.javascript.events "onClick | onDblClick | onMouseDown | onMouseUp | onMouseOver | onMouseMove | onMouseOut | onKeyPress | onKeyDown | onKeyUp | onFocus | onBlur | onLoad | onUnload | onSubmit | onReset | onChange | onError | onHelp | onSelect | Queryopen | Queryrecalc | Postrecalc | Querymodechange | Postmodechange | Postsave | Querysend | Postsend | library">

これらのコードイベントオプションは、次に示すタイミングで実行されます。

library

JavaScript スクリプトライブラリが実行可能であるとき。LotusScript や Java と異なり、JavaScript スクリプトは特定のオブジェクトに添付されません。また、JavaScript スクリプトで作成された特定のクラスには、エージェントまたはサーブレットからアクセスできません。

onBlur

オブジェクトが入力フォーカスを失ったとき。

onChange

オブジェクトの内容を変更したとき。

onClick

マウスボタンを押して離したとき。

onDblClick

2 回連続してマウスボタンを押して離したとき。

onError

ロード中にエラーが発生したとき。

onFocus

オブジェクトにフォーカスがあたったとき。

onHelp

ブラウザがアクティブなウィンドウである間に、[F1] キーを押したとき。

onKeyDown

キーを押したとき。

onKeyPress

英数字のキーを押して離したとき。

onKeyUp

押したキーを離したとき。

onLoad

ブラウザにオブジェクトがロードされたとき。

onMouseDown

マウスボタンを押したとき。

onMouseMove

オブジェクトの上でマウスカーソルを移動したとき。

onMouseOut

オブジェクトの境界線の外側にマウスカーソルを移動したとき。

onMouseOver

オブジェクトの境界線の内側にマウスポインタを移動したとき。

onMouseUp

マウスボタンを離したとき。

onReset

フォームをリセットしたとき。

onSelect

テキスト領域または入力タイプのテキストオブジェクト内のテキストを選択したとき。

onSubmit

フォームを送信する前。

onUnload

ブラウザがオブジェクトを閉じる前。

Postmodechange

文書を読み込みモードまたは編集モードに変更した後。

Postrecalc

データベース、ビュー、フォルダ、文書が再計算された後。

Postsave

文書が保存された後。

Postsend

文書が送信された後。

Querymodechange

文書が読み込みモードまたは編集モードに変更される前。

Queryopen

ビュー、フォルダ、文書が開かれる前。

Queryrecalc

ビュー、フォルダ、文書が再計算される前。

Querysend

文書が送信される前。

%code.javascript.sections; エンティティは、オブジェクトの JavaScript イベントに適用されるグローバルセクションのリストを表します。

構文:

<!ENTITY % code.javascript.sections " jsheader ">

jsheader

JavaScript イベントのヘッダー情報です。

%code.lotusscript.events; エンティティは、LotusScript コードの実行をトリガーする複数のイベントのリストを表します。このエンティティは %code.events; エンティティで使用されます。

構文:

<!ENTITY % code.lotusscript.events "initialize | terminate | entering | exiting | onchange | objectexecute ">

これらのコードイベントオプションは、次に示すタイミングで実行されます。

entering

フォーカスがフィールドに入ったとき。

exiting

フォーカスがフィールドを出たとき。

initialize

データベース、ビュー、フォルダ、文書、オブジェクト、エージェントがロードされたとき。

objectexecute

アクション、ボタン、ホットスポットが FX/Notes フロー対応の OLE2 サーバーでアクティブになったとき。

onchange

ユーザーが編集モードでフィールドを変更したとき。

terminate

データベース、ビュー、フォルダ、文書、オブジェクト、エージェントが閉じられたとき。

%code.lotusscript.or.formula.events; エンティティは、LotusScript または式言語のコードの実行をトリガーする複数のイベントのリストを表します。このエンティティは %code.events; エンティティに含まれます。

構文:

<!ENTITY % code.lotusscript.events "action | onhelp | queryopen | queryrecalc | postopen | querymodechange | querysend | postsend | postmodechange | postrecalc | querysave | postsave | queryclose | click | regiondoubleclick | queryopendocument | queryaddtofolder | querydragdrop | querypaste | postdragdrop | postpaste | onload | onunload | onsubmit | queryentryresize | postentryresize | %code.databasescript.lotusscript.or.formula.events; ">

これらのコードイベントオプションは、次に示すタイミングで実行されます。

action

[アクション] メニューのアクションを選択したか、アクションバーのアクションボタンをクリックしたとき。

click

アクション、ボタン、ホットスポットを選択したとき。

onhelp

状況依存ヘルプを表示するために [F1] キーを押したとき。

onload

現在の文書が開かれてからユーザーが入力フォーカスを得るまでの間。

onsubmit

現在の文書が保存される前。

onunload

現在の文書が閉じられる前。

postdragdrop

データベーススクリプトまたはカレンダーのフォルダまたはビュー内のドラッグアンドドロップ操作の後。

postentryresize

カレンダービューのエントリがサイズ変更された後。

postmodechange

文書を読み込みモードまたは編集モードに変更した後。

postopen

データベース、ビュー、フォルダ、文書が開かれた後。

postpaste

フォルダまたはビュー内の貼り付け操作の後。

postrecalc

文書が更新され、その値が再計算された後。

postsave

文書が保存された後。

postsend

文書が送信された後。

queryaddtofolder

文書がフォルダに追加される前。

queryclose

データベース、ビュー、フォルダ、文書が閉じられた後。

querydragdrop

データベーススクリプトまたはカレンダーのビューまたはフォルダ内のドラッグアンドドロップ操作の前。

queryentryresize

カレンダービューのエントリがサイズ変更される前。

querymodechange

文書が読み込みモードまたは編集モードに変更される前。

queryopen

ビュー、フォルダ、文書が開かれる前。

queryopendocument

文書がフォルダまたはビューにロードされる前。

querypaste

フォルダまたはビュー内の貼り付け操作の前。

queryrecalc

ビュー、フォルダ、文書が再計算される前。

querysave

文書が保存される前。

querysend

文書が送信される前。

regiondoubleclick

カレンダーのビューまたはフォルダ内の領域がダブルクリックされたとき。

%code.lotusscript.sections; エンティティは、オブジェクトの LotusScript イベントに適用されるグローバルセクションのリストを表します。

構文:

<!ENTITY % code.lotusscript.sections " options | declarations ">

これらのセクションオプションは、記述できる領域を指定します。

declarations

非実行可能 LotusScript ステートメントです。

options

Option、Use、UseLSX、Const などの LotusScript ステートメントです。

%code.sections; エンティティは、オブジェクトのイベントに適用されるグローバルセクションの種類のリストを表します。

構文:

<!ENTITY % code.sections " %code.lotusscript.sections; | %code.javascript.sections; ">

%code.types; エンティティは、Notes がサポートするコーディング言語を表します。このエンティティには、<formula>、<lotusscript>、<javascript>、<javaproject>、<simpleaction> の各要素が含まれます。

構文:

<!ENTITY % code.types " formula | javascript | lousscript | javaproject | simpleaction+ ">

例

例