X-FC-FIELDタグの構文
以下は、X-FC FIELDタグの構文の一覧です。
構文
<X-FC-FIELD [Bag.]FieldID[.FieldIndex] [DEFAULT=DefaultValue] Format>
<X-FC-FIELD [Bag.]NDX.[Index] [DEFAULT=DefaultValue] Format>
Bag
これを指定すると、指定したフィールドで探すフォームデータのセットが決定されます。このタグの種類は、指定されるBagによって変わります。Bagを指定しないと、使用されるフォームデータのセットは、現在のオブジェクトの「normal」フィールドデータのセット全体となります(BASEバッグとCALバッグを組み合わせたもの)。
利用可能なバッグとその関連タグは次の通りです。
BASE
タグの種類:一般的なオブジェクト
BASEバッグは、現在のオブジェクトの通常のフォームデータです。
LATE
タグの種類:一般的なオブジェクト
LATEバッグは現在のオブジェクトの特別なフォームデータで、入力された後にサーバによって送信されます。現在、これを利用できるのはチャットだけです(進行中の会話が「LATE」フォームデータです)が、将来は他のオブジェクトでも利用できるようになる予定です。
USERPREF
タグの種類:セッション
USERPREFバッグには、ユーザの[基本設定]フォームに保存されているフォームデータが含まれます。
クライアント版の[ユーザの基本設定]フィールドでIDが10000を超えるフィールドは、サーバではなくローカルハードディスクに保存されます。したがって、Webからは利用できません。
SITEPREF
タグの種類:サーバ
SITEPREFバッグには、現在のサイトの[サイトの基本設定]フォームに保存されているフォームデータが含まれます。
PREFS
タグの種類:サーバ
PREFSバッグによって、ユーザとサイトの基本設定を組み合わせた表示が提供されます。このバッグはインタフェース内で使用され、ユーザの基本設定がサイトの基本設定の一部(ページサイズ、アイコンサイズなど)より優先して適用されるようにします。
SESS
タグの種類:セッション
SEESバッグには、サーバに関するデータと、ユーザがログインした時にサーバが送信するユーザのアカウントに関するデータが含まれます。このバッグの対象となるデータの大半には、<X-FC-SERVER>タグか<X-FC-USER>タグを使用してアクセスできます。
CAL
タグの種類:特定のオブジェクト(カレンダー)
CALバッグには、カレンダーの一覧に固有にフィールドデータが含まれます。このバッグはかなり旧式のもので、以前ここに保存されていたデータにアクセスするには、今では<X-FC-CALENDAR-ITEM>タグを使用します。
FieldID引数は、データ取得対象のフィールドをフィールドIDによって指定します。
FieldIndex引数は、所定のフィールドがフィールドアレイを指している場合に使用するフィールド指定するのに使用します。アレイ内のフィールド数は、<X-FC-FIELD-COUNT>を使って調べることができます。FieldIndex引数が見つからない場合、FieldIndexは0であるとみなされます。
NDX.Index引数は、、データ取得対象のフィールドを、指定されたバッグでのデータ位置を使用して指定します。フォームデータのバッグ内のエントリ数は、<X-FC-RECIPIENT-COUNT>を使って調べることができます。
DEFAULT引数は、特定のフィールドが存在しない場合に使用する値を指定します。DefaultValueは、次のいずれかの形式を取ることができます。
ExplicitValue
フィールドの明示的なデフォルト値を指定します。スペースを含む文字列を値として使用する場合は、その文字列を引用符で囲まなければなりません。
LANG.SingleStringID
現在のlang.rezファイル内の単一文字列リソースを指定して、デフォルト値として使用します。
LANG.StringID.StringIndex
現在のlang.rezファイル内の文字列リソースを指定して、デフォルト値として使用します。
LANG.FormID.FieldID.PropertyID
FORM.FieldID.PropertyID
PROP.PropertyID
この3つの引数は、現在のlang.rezファイル内にあるフォームのリソースからコントロールプロパティフォームを指定して、デフォルト値として使用するのに使用します。FORM引数とPORP引数では、フォームIDは暗黙的に現在のフォームのIDに設定されます。また、PROP引数では、フィールドIDも、デフォルト値が求められているフィールドのIDに暗黙的に設定されます。フォームコントロールの一覧とそのプロパティについては、FirstClassオンラインのIS Script LibraryにあるFirstClass Form Controlsのドキュメントを参照してください。※詳細はFCマネジメントまでお問い合わせください。
Format引数は、フィールドデータの書式設定方法を指定するのに使用します。有効な書式は次の通りです。
EXISTS
指定したフィールドが存在する場合は1、存在しない場合は0を出力します。
ID
指定したフィールドのフィールドIDを出力します。
INDEX
指定したフィールドのインデックスを出力します。
TYPE
指定したフィールドのFirstClassのフィールドタイプを出力します(これは、バッチ管理を使用してフィールドを返すのが主な目的です)。
CLASS[.FormID][.FieldID]
現在のlang.rezファイルにあるフォームコントロールに基づいて、適切な方法でフィールドデータの出力と書式設定を行うようインターネットサービスに指示します。オプションのFormIDパラメータが指定されていない場合は、現在のフォームIDとみなされます。オプションのFieldIDパラメータが指定されていない場合は、データフィールドのIDとみなされます。オプションのパラメータが1つだけ指定されている場合は、.FiledIDパラメータとして処理されます。
RAW
このフィールドのデータを「未処理」のまま出力します(フィールドタイプによって、LITERALSTRING、NUMBER、またはBASE64のいずれかの書式になります)。所定のフィールドに使用する未処理の書式は、RAWTYPE書式を使用して決めることができます。
RAWTYPE
指定したフィールドの標準データ型を出力します(「STRING」「NUMBER」または「BINARY」のいずれかになります)。
BASE64
BASE64エンコードされた文字列のバイトデータとしてフィールドのデータを出力します。これは、標準的なバイナリデータを表示するのに使用する一般的な書式です。
LITERALSTRING
エンコードも書式設定もされていない文字列としてフィールドのデータを出力します。
PASSWORD[,MaskCharacter]
大半のパスワード入力コントロールと同じような方法でマスク処理したデータを出力します。MaskCharacterを指定しない場合は、アスタリスク(*)が使用されます。
LENGTH
長さをデータのバイト数で出力します。フィールドが存在しない場合は、0が出力されます。
STRLEN
長さをデータの文字数で出力します。フィールドが存在しない場合、または文字列でない場合は、0が出力されます。
STRING
保存されたデータを表示するのに必要な場合に、HTMLエンティティにエンコードした<br>タグ付き文字列としてデータを出力します。
MULTILINESTRING
改行はCRLFシーケンスとして残したままHTMLエンティティにエンコードした文字列としてフィールドデータを出力します。
ESCAPED
JavaScript変数に割り当てられるようにエスケープ処理した文字列としてフィールドデータを出力します。
URLESCAPED
URLで使用できるようにエスケープ処理した文字列としてフィールドデータを出力します。
IMGURL
画像ファイル名としてフィールドデータを処理し、その画像へのURLを出力します。
STYLED[.LATE].FieldID[.Index] [EMBED | AUTOPLAY]
FirstClassスタイルのテキストパケットのテキスト部分としてフィールドを処理します。[.LATE].FieldID[.Index]パラメータを使用して、パケットのスタイル部分が保存されているフィールドIDを指定すると、2つのプロパティがHTMLスタイルのテキストとして出力されます(X-FC-BODYによる本文のテキスト出力と同じような処理です)。EMBED引数は、HTML埋め込みタグを使用して画像ではないオブジェクトを埋め込むようインターネットサービスに指示します。また、AUTOPLAY引数は、HTMLのオブジェクトを埋め込むだけでなく、「自動再生」オプションを指定するようインターネットサービスに指示します。
NUMBER[,NumberFormat]
データを数値として出力します。デフォルトでは、出力結果は符号付き10進数になりますが、NumberFormatパラメータの設定をこれより優先して適用させることができます。NumberFormatの値は次の通りです。
d 符号付き10進数(デフォルト)
u 符号なし10進数
x 16進数(小文字のaからf)
X 16進数(大文字のAからF)
RGB[,ColourFormat]
RGBA色指定子としてデータを処理します。デフォルトでは、16進数でRGBの3色を指定した値にハッシュ記号(#)を先頭に付けた形で出力されます(HTML色指定の#RRGGBB)。ただし、ColourFormatパラメータの設定をこれより優先して適用させることができます。複数のColourFormatパラメータを続けて表記することで組み合わせることができます(RGB, rdは、フィールドの赤コンポーネントを10進数で出力します)。ColourFormatの値は次の通りです。
x 16進数(ハッシュ記号の接頭辞なし)。「d」を除く他のColourFormatパラメータと併せて使用できます。
d 10進数「x」を除く他のColourFormatパラメータと併せて使用できます。
r 赤コンポーネントだけを出力します。「d」または「x」のColourFormatパラメータと併せて使用できます。
g 緑コンポーネントだけを出力します。「d」または「x」のColourFormatパラメータと併せて使用できます。
b 青コンポーネントだけを出力します。「d」または「x」のColourFormatパラメータと併せて使用できます。
A アルファチャンネル(不透過度)コンポーネントだけを出力します。「d」または「x」のColourFormatパラメータと併せて使用できます。
a アルファチャンネル(不透過度)コンポーネントを追加して8ビットの出力値にします(#RRGGBB -> #RRGGBBAA)。「d」または「x」のColourFormatパラメータと併せて使用できます。
FONTSIZE
データをMacフォントのポイントサイズとして処理し、現在のブラウザに合うように変更されたポイントサイズを出力します(最近のブラウザの大半は、FirstClassが使用するMacフォントのポイントサイズではなく、dpiの値に基づいたWindowsフォントのポイントサイズを使用しています)。
CHARSET
FirstClassの文字セットの列挙値として処理し、対応する文字セットを出力します。
POINT[.coordinate]
画面の座標を指定する順序対の16ビット数値としてデータを処理します。デフォルトの出力は順序対(X,Y)ですが、「X」または「Y」をcoordinateパラメータとして個別に指定することで、X座標またはY座標を別々に抽出できます。
RECT[.rectformat]
ボックスの大きさを指定する4組の16ビット数値としてデータを処理します。デフォルトの出力は順序リスト(上、左、下、右)ですが、「T」「L」「B」「R」をrectformatパラメータとして個別に使用することで、ボックスの各辺を抽出できます。また、「W」または「H」をrectformatパラメータとして使用すると、ボックスの幅と高さのピクセル値がそれぞれ計算され、抽出されます。
DURATION
データを期間(秒数)として処理し、適切な書式を設定します。インターネットサービスは、lang.rezファイルをチェックして、現在のフォームとフィールドのために一定の期間を指定する「特殊な」文字列があるかどうかを確認します(lang.rezのフォームが期間0を「無効」に対応付けしているかどうか、など)。
DATE[,"DateFormat"]
(1904年1月1日からの秒数として保存された)FirstClassの日付フィールドとしてデータを処理します。オプションの「DateFormat」パラメータを使用して、出力結果の書式を設定できます(インターネットサービススクリプトの日付書式を参照)。
LIST=EnumerationSpecifier
データを列挙リストのインデックスとして処理し、EnumerationSpecifierに基づいて、対応する列挙値を出力します。EnumerationSpecifierは、DEFAULT引数のパラメータと同じ形式を取ります(明示的に列挙されたリストにするか、LANG/FORM/PROP構文を使用してリソースから取り出すことができます)。
NUMFIELD[[.FormID].FieldID]
FirstClassの数値フィールドコントロール用に保存された値としてデータを処理し、lang.rezファイルから抽出したデータに基づいて適切な形で出力します。オプションのFormIDパラメータが指定されていない場合は、現在のフォームIDとみなされます。オプションのFieldIDパラメータが指定されていない場合は、データフィールドのIDとみなされます。オプションのパラメータが1つだけ指定されている場合は、.FiledIDパラメータとして処理されます。
| ||