ig.excel.CustomView

Microsoft Excel のカスタム表示を表します。

備考

カスタム表示は、表示オプションを保存する方法を提供し、オプションでワークブックおよびワークブックの各ワークシートのオプションを印刷します。 これらのオプションは、ワークブックおよびワークシートで現在設定されているオプションで異なります。

複数のカスタム表示はワークブックで保存でき、カスタム表示のオプションは、その CustomView.apply メソッドを呼び出して関係するワークブックに適用できます。

依存関係

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。
  • apply

    .apply( );

    関連するワークブックおよびそのワークシートにカスタム表示のすべてのオプションを適用します。

    例外

    例外 説明
    ig.InvalidOperationException カスタム表示は、関係するワークブックから以前に削除されました。

    備考

    現在適用されているカスタム表示を示すワークブックの状態がないので、カスタム表示の適用は、単純にそれで保存されたすべてのオプションをワークブックおよびそのワークシートにコピーします。適用されたカスタム表示が変更されると、それらの変更はワークブックまたはワークシートで更新されません。その代わりに、カスタム表示は、ワークブックまたはワークシートで変更を半径するために再適用する必要があります。

  • getDisplayOptions

    .getDisplayOptions( worksheet:ig.excel.Worksheet, [createIfNull:boolean] );
    返却型:
    ig.excel.CustomViewDisplayOptions
    返却型の説明:
    ワークシートがこのカスタム表示に関連するワークブックに属しない場合は null、そうでなければワークシートに関連する表示オプション。

    指定したワークシートに関連付けられた表示オプションを取得します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • 関連する表示オプションのワークシートが取得されます。
    • createIfNull
    • タイプ:boolean
    • オプション
    • 割り当てられていない場合、True に設定し表示のオプションを作成します。オプションは、ワークシートの現在の状態に基づき初期化されます。このオプションは、ブック読み込み時にワークシートのオプションがない場合にのみ、null 値をとります。

    例外

    例外 説明
    ig.ArgumentNullException worksheet は null です。

    備考

    返された DisplayOptions インスタンスでプロパティを設定しても、ワークシートの実際の表示は変わりません。プロパティの設定後、CustomViewCustomView.apply メソッドが変更内容をワークシートに適用します。

  • getHiddenColumns

    .getHiddenColumns( worksheet:ig.excel.Worksheet, [createIfNull:boolean] );
    返却型:
    ig.excel.HiddenColumnCollection
    返却型の説明:
    CustomView.saveHiddenRowsAndColumns が False またはワークシートがこのカスタム表示に関連するワークブックに属しない場合は null、そうでなければワークシートに関連する非表示列のコレクション。

    指定したワークシートに関連付けられた非表示列を取得します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • 関連する非表示列のワークシートが取得されます。
    • createIfNull
    • タイプ:boolean
    • オプション
    • ワークシートに割り当てられていない場合、True に設定し非表示の列を作成します。オプションは、現在の状態に基づき初期化されます。このオプションは、ブック読み込み時にワークシートのオプションがない場合にのみ、null 値をとります。 CustomView.saveHiddenRowsAndColumns が True でない限り、コレクションを割り当てません。

    例外

    例外 説明
    ig.ArgumentNullException worksheet は null です。

    備考

    返された HiddenColumnCollection インスタンスで列を追加しても、ワークシートの列が実際には非表示になることはありません。このコレクション内で非表示の列を変更した後、CustomViewCustomView.apply メソッドが列の表示/非表示を変更します。

  • getHiddenRows

    .getHiddenRows( worksheet:ig.excel.Worksheet, [createIfNull:boolean] );
    返却型:
    ig.excel.HiddenRowCollection
    返却型の説明:
    CustomView.saveHiddenRowsAndColumns が False またはワークシートがこのカスタム表示に関連するワークブックに属しない場合は null、そうでなければワークシートに関連する非表示行のコレクション。

    指定したワークシートに関連付けられた非表示行を取得します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • 関連する非表示行のワークシートが取得されます。
    • createIfNull
    • タイプ:boolean
    • オプション
    • ワークシートに割り当てられていない場合、True に設定し非表示の列を作成します。オプションは、現在の状態に基づき初期化されます。このオプションは、ブック読み込み時にワークシートのオプションがない場合にのみ、null 値をとります。 CustomView.saveHiddenRowsAndColumns が True でない限り、コレクションを割り当てません。

    例外

    例外 説明
    ig.ArgumentNullException worksheet は null です。

    備考

    返された HiddenRowCollection インスタンスで行を追加しても、ワークシートの行が実際に非表示になることはありません。このコレクション内で非表示の行を変更した後、CustomViewCustomView.apply メソッドが行の表示/非表示を変更します。

  • getPrintOptions

    .getPrintOptions( worksheet:ig.excel.Worksheet, [createIfNull:boolean] );
    返却型:
    ig.excel.PrintOptions
    返却型の説明:
    CustomView.savePrintOptions が False またはワークシートがこのカスタム表示に関連するワークブックに属しない場合は null、そうでなければワークシートに関連する印刷オプション。

    指定したワークシートに関連付けられた印刷オプションを取得します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • 関連する印刷オプションのワークシートが取得されます。
    • createIfNull
    • タイプ:boolean
    • オプション
    • 割り当てられていない場合、True に設定し印刷のオプションを作成します。オプションは、ワークシートの現在の状態に基づき初期化されます。このオプションは、ブック読み込み時にワークシートのオプションがない場合にのみ、null 値をとります。CustomView.savePrintOptions が True でない限り、コレクションを割り当てません。

    例外

    例外 説明
    ig.ArgumentNullException worksheet は null です。

    備考

    返される PrintOptions インスタンスでプロパティを設定しても、ワークシートの印刷設定が実際に変更されることはありません。プロパティの設定後、CustomViewCustomView.apply メソッドが変更内容をワークシートに適用します。

  • name

    .name( );
    返却型:
    string
    返却型の説明:
    カスタム表示の名前です。

    カスタム表示の名前を取得します。

    例外

    例外 説明
    ig.ArgumentNullException 割り当てた値が null または空です。
    ig.ArgumentException 指定される値は、このカスタム表示の関連するワークブック (カスタム表示名は大文字と小文字を区別せずに比較される) の他のカスタム表示の名前になります。

    備考

    カスタム表示の名前は Microsoft Excel のカスタム表示ダイアログに表示され、ワークブックの他のカスタム表示に対して大文字と小文字を識別しない一意でなければなりません。

  • name

    .name( value:string );
    返却型:
    string
    返却型の説明:
    カスタム表示の名前です。

    カスタム表示の名前を取得します。

    • value
    • タイプ:string

    例外

    例外 説明
    ig.ArgumentNullException 割り当てた値が null または空です。
    ig.ArgumentException 指定される値は、このカスタム表示の関連するワークブック (カスタム表示名は大文字と小文字を区別せずに比較される) の他のカスタム表示の名前になります。

    備考

    カスタム表示の名前は Microsoft Excel のカスタム表示ダイアログに表示され、ワークブックの他のカスタム表示に対して大文字と小文字を識別しない一意でなければなりません。

  • saveHiddenRowsAndColumns

    .saveHiddenRowsAndColumns( );
    返却型:
    boolean
    返却型の説明:
    非表示行および列設定がカスタム表示で保存されるかどうかを示す値。

    非表示行および列設定がカスタム表示で保存されるかどうかを示す値を取得します。

    備考

    この値が False の場合、指定されたワークシートに関係なく、CustomView.getHiddenColumns および CustomView.getHiddenRows の戻り値は常に null になります。

  • savePrintOptions

    .savePrintOptions( );
    返却型:
    boolean
    返却型の説明:
    印刷オプションがカスタム表示で保存されるかどうかを示す値。

    印刷オプションがカスタム表示で保存されるかどうかを示す値を取得します。

    備考

    この値が False の場合、指定されたワークシートに関係なく、CustomView.getPrintOptions の戻り値は常に null になります。

  • windowOptions

    .windowOptions( );
    返却型:
    ig.excel.CustomViewWindowOptions
    返却型の説明:
    カスタム表示に関連するワークブックのウィンドウ オプション。

    カスタム表示に関連するワークブックのウィンドウ オプションを取得します。

    備考

    返された CustomView.windowOptions インスタンスでプロパティを設定しても、関連するワークブックのウィンドウ オプションが実際に変更されることはありません。プロパティの設定後、CustomViewCustomView.apply メソッドが変更内容をワークブックに適用します。

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.