[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Inputman.GcFormPersistence

GcFormPersistence クラス

フォームデータの永続化（ページの更新や複数のセッションにわたってフォーム入力値を保持する）のためのUIの無いコンポーネントを定義します。 注意）プライベートモードやシークレットモードに設定されたブラウザでは本機能は適切に動作しません。

階層

  • GcFormPersistence

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

プロパティ

読み取り専用 componentName

componentName: string

コンポーネント名（'GcFormPersistence'）を取得します。

id

id: string

このフォームのストレージキーの一意の識別子。 IDのないフォームを使用する場合は必須です。 指定しない場合、フォームIDが使用されます。

saveMode

saveMode: SaveMode

フォームデータを保存するタイミング（RefereshまたはSubmit）を取得または設定します。

storageMode

storageMode: StorageMode

フォームデータの保存先（セッションストレージまたはローカルストレージ）を取得または設定します。

メソッド

clearStorage

  • clearStorage(): void

  • セッションストレージまたはローカルストレージに保存されたデータを消去します。

    戻り値 void

getValue

  • getValue(name: string): object

  • キーの名称を渡すと、ストレージからそのキーに対する値を返します。

    引数

    • name: string

      値を取り出したいキーの名称

    戻り値 object

persist

  • persist(): void

  • フォームデータを保存し永続化します。

    戻り値 void

setValue

  • setValue(name: string, value: object): void

  • キーの名称と値を渡すと、ストレージにキーを追加する、またはキーがすでに存在する場合はキーに対する値を更新します。

    引数

    • name: string

      作成または更新したいキーの名称

    • value: object

      キーに対する値

    戻り値 void

skip

  • skip(f: (element: HTMLElement): boolean): void

  • 現在の要素をスキップする際の処理を設定します。

    引数

    • f: (element: HTMLElement): boolean
        • (element: HTMLElement): boolean

        • 引数

          • element: HTMLElement

          戻り値 boolean

    戻り値 void

unPersist

  • unPersist(): void

  • フォームデータの永続化をキャンセルします。これまでストレージに格納されていたフォームデータは削除され、今後データは保存されなくなります。

    戻り値 void

静的 registerEditor

  • データを永続化したいサードパーティ製品に対して個別のルール（IThirdpartyEditor）を登録します。 これにより、HTML標準のInput要素、InputManJSコントロールだけでなく、Wijmoなどサードパーティ製品ライブラリのデータを永続化できます。 ルールでは、ストレージからのデータ取得およびコントロールへのデータ復元、コントロールからのデータ取得およびストレージへのデータ保存、などの処理を定義します。

    引数

    戻り値 void