ig.excel.Workbook

Microsoft Excel ワークブックを表します。

備考

各ワークブックは１つまたは複数のワークシート (Worksheet) で構成されています。デフォルト コンストラクターは空のワークブックを作成します。

依存関係

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

  • maxExcel2007CellFormatCount

    タイプ:
    number
    デフォルト:
    64000

    Excel 2007 ファイル形式で許可されている、ワークブック内の最大のセル書式数。

  • maxExcel2007ColumnCount

    タイプ:
    number
    デフォルト:
    16384

    Excel 2007 ファイル形式で許可されている、ワークシート内の最大の列数。

  • maxExcel2007RowCount

    タイプ:
    number
    デフォルト:
    1048576

    Excel 2007 ファイル形式で許可されているワークシート内の最大の行数。

  • maxExcelCellFormatCount

    タイプ:
    number
    デフォルト:
    4000

    Excel 97-2003 ファイル形式で許可されている、ワークブック内の最大のセル書式数。

  • maxExcelColumnCount

    タイプ:
    number
    デフォルト:
    256

    Excel 97-2003 ファイル形式で許可されている、ワークシート内の最大の列数。

  • maxExcelRowCount

    タイプ:
    number
    デフォルト:
    65536

    Excel 97-2003 ファイル形式で許可されている、ワークシート内の最大の行数。

  • maxExcelWorkbookFonts

    タイプ:
    number
    デフォルト:
    512

    Excel で許可されるワークブックのフォントの最大数です。

このコントロールにイベントはありません。

  • ig.excel.Workbook
    コンストラクター

    new $.ig.excel.Workbook( );

    Workbook クラスの新しいインスタンスを作成します。

    備考

    作成された新しいワークブックは空です。Worksheet を少なくとも 1 つ追加していなければワークブックを保存できません。

    関連項目

  • ig.excel.Workbook
    コンストラクター

    new $.ig.excel.Workbook( format:ig.excel.WorkbookFormat );

    Workbook クラスの新しいインスタンスを作成します。

    • format
    • タイプ:ig.excel.WorkbookFormat
    • 形式制限の設定と保存をする時に使用するファイル形式です。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 書式が WorkbookFormat 列挙体で定義されていません。

    備考

    作成された新しいワークブックは空です。Worksheet を少なくとも 1 つ追加していなければワークブックを保存できません。

    関連項目

  • calculationMode

    .calculationMode( );
    返却型:
    ig.excel.CalculationMode
    返却型の説明:
    参照される値が変更される時に数式が再計算される方法を示す値。

    参照される値が変更される時に数式が再計算される方法を示す値を取得します。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Workbook.calculationMode 列挙体で定義されていません。

    備考

    これが Manual の値に設定されている場合、Workbook.recalculateBeforeSave プロパティは数式がファイルを保存する直前に再計算されるかどうかを決定します。そうでなければ、このプロパティは無視されます。

    関連項目

  • calculationMode

    .calculationMode( value:ig.excel.CalculationMode );
    返却型:
    ig.excel.CalculationMode
    返却型の説明:
    参照される値が変更される時に数式が再計算される方法を示す値。

    参照される値が変更される時に数式が再計算される方法を示す値を取得します。

    • value
    • タイプ:ig.excel.CalculationMode

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Workbook.calculationMode 列挙体で定義されていません。

    備考

    これが Manual の値に設定されている場合、Workbook.recalculateBeforeSave プロパティは数式がファイルを保存する直前に再計算されるかどうかを決定します。そうでなければ、このプロパティは無視されます。

    関連項目

  • cellReferenceMode

    .cellReferenceMode( );
    返却型:
    ig.excel.CellReferenceMode
    返却型の説明:
    ワークブックのセルが参照される方法を示す値。

    ワークブックのセルが参照される方法を示す値を取得します。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Workbook.cellReferenceMode 列挙体で定義されていません。

    備考

    このプロパティの値は、Microsoft Excel で開かれる時にワークブックの行ラベルと列ラベルに影響を及ぼします。 さらに、これは異なるセルを参照する数式の表示に影響を及ぼします。

  • cellReferenceMode

    .cellReferenceMode( value:ig.excel.CellReferenceMode );
    返却型:
    ig.excel.CellReferenceMode
    返却型の説明:
    ワークブックのセルが参照される方法を示す値。

    ワークブックのセルが参照される方法を示す値を取得します。

    • value
    • タイプ:ig.excel.CellReferenceMode

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Workbook.cellReferenceMode 列挙体で定義されていません。

    備考

    このプロパティの値は、Microsoft Excel で開かれる時にワークブックの行ラベルと列ラベルに影響を及ぼします。 さらに、これは異なるセルを参照する数式の表示に影響を及ぼします。

  • characterWidth256thsToPixels

    .characterWidth256thsToPixels( characterWidth256ths:number );
    返却型:
    number
    返却型の説明:
    characterWidth256ths 値に相当するピクセル数。

    平均文字幅の 1/256 の単位をピクセルへ変換します。

    • characterWidth256ths
    • タイプ:number
    • 平均文字幅の1/256 の単位数。

    備考

    デフォルト フォントの高さを基にした平均文字幅の 1/256 の単位。

    関連項目

  • clearConnectionData

    .clearConnectionData( );

    Workbook から外部のデータ接続を作成します。

  • clearPivotTableData

    .clearPivotTableData( );

    すべてのピボット テーブルおよび関連したスライサーを Workbook からクリアします。

  • createNewWorkbookFont

    .createNewWorkbookFont( );
    返却型:
    ig.excel.IWorkbookFont
    返却型の説明:
    作成されたExcelフォントオブジェクト。

    新しいワークブック フォントを作成する Factory メソッド。

    備考

    IWorkbookFont は Excel ワークブックで使用されるフォントを表します。 Excel ブックの多くの部分で同じ複雑な (複数のプロパティが共通の) フォント書式設定を使用する場合は、このメソッドを次のように使用します。

    1. Workbook.createNewWorkbookFont で新しいフォント書式設定を作成します。
    2. 指定されたフォント書式設定にすべての必要なプロパティを設定します。
    3. IWorkbookFont.setFontFormatting メソッドでフォント書式設定を使用するすべての Excel オブジェクトにそのフォント書式設定を適用します。

    この手順を使用すると、複雑なフォント書式のコーディングが簡単になり、作成されたプログラムの速度も向上します。どのような方法を使用してもフォント書式は内部的にキャッシュされるため、この手順を使用してもワークブック内のフォント書式の総数は減りません。

  • createNewWorksheetCellFormat

    .createNewWorksheetCellFormat( );
    返却型:
    ig.excel.IWorksheetCellFormat
    返却型の説明:
    作成されたセル フォーマット。

    新しいワークシートセル書式を作成します。

    備考

    IWorksheetCellFormat はセル固有の書式設定（フォント、数値書式、外観など）を表します。Excel ワークブック内のセル書式の総数は Workbook.maxExcelCellFormatCount に制限されます。 Excel ブックの多くの部分で同じ複雑な (複数のプロパティが共通の) セル書式設定を使用する場合は、このメソッドを次のように使用します。

    1. Workbook.createNewWorksheetCellFormat で新しいセル書式設定を作成します。
    2. 指定されたセル書式設定にすべての必要なプロパティを設定します。
    3. IWorksheetCellFormat.setFormatting メソッドでセル書式設定を使用するすべての Excel オブジェクトにそのフォント書式設定を適用します。

    この手順を使用すると、複雑なセル書式のコーディングが簡単になり、作成されたプログラムの速度も向上します。どのような方法を使用してもセル書式は内部的にキャッシュされるため、この手順を使用してもワークブック内のセル書式の総数は減りません。

  • culture

    .culture( );
    返却型:
    string
    返却型の説明:
    ワークブックの現在のカルチャまたはスレッドの現在のカルチャを使用する場合 Null。

    カルチャを意識した変換または比較をじっこするう際にワークブックの現在のカルチャとして使用するためのカルチャを取得します。

    備考

    注: カルチャがワークブック ファイルに保存または読み込まれない場合、ワークブックに関連付けられているか所有されているオブジェクトへアクセスおよび操作する際にのみ使用されます。

  • culture

    .culture( value:string );
    返却型:
    string
    返却型の説明:
    ワークブックの現在のカルチャまたはスレッドの現在のカルチャを使用する場合 Null。

    カルチャを意識した変換または比較をじっこするう際にワークブックの現在のカルチャとして使用するためのカルチャを取得します。

    • value
    • タイプ:string

    備考

    注: カルチャがワークブック ファイルに保存または読み込まれない場合、ワークブックに関連付けられているか所有されているオブジェクトへアクセスおよび操作する際にのみ使用されます。

  • currentFormat

    .currentFormat( );

    ワークブックの現在のフォーマットを取得します。これは、保存や形式の制限を設定するために使用される形式です。

    関連項目

  • customTableStyles

    .customTableStyles( );

    このワークブック内のカスタム テーブルのコレクションを取得します。

    関連項目

  • customTableStyles

    .customTableStyles( index:number );
    返却型:
    ig.excel.WorksheetTableStyle
    返却型の説明:
    指定したインデックスにある WorksheetTableStyle インスタンス。

    このワークブック内のカスタム テーブルのコレクションを取得します。

    • index
    • タイプ:number
    • 取得したい WorksheetTableStyle の位置を示すインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスが 0 未満、または CustomTableStyleCollection.count 以上の値です。

  • customTableStyles

    .customTableStyles( name:string );
    返却型:
    ig.excel.WorksheetTableStyle
    返却型の説明:
    指定したインデックスにある WorksheetTableStyle インスタンス。

    このワークブック内のカスタム テーブルのコレクションを取得します。

    • name
    • タイプ:string
    • 調べたい WorksheetTableStyle の名前。

    備考

    テーブル スタイル名は大文字と小文字を区別せずに比較されます。

  • customViews

    .customViews( );
    返却型:
    ig.excel.CustomViewCollection
    返却型の説明:
    ワークブックのカスタム表示のコレクション。

    ワークブックのカスタム表示のコレクションを取得します。

    備考

    各カスタム表示は表示設定を保存し、オプションで設定を印刷します。これは CustomView.apply メソッドを呼び出すことによって、Microsoft Excel UI および Excel アセンブリの両方から後でワークブックおよびそのワークシートに 1 つの操作として適用できます。

    関連項目

  • customViews

    .customViews( index:number );
    返却型:
    ig.excel.CustomView
    返却型の説明:
    ワークブックのカスタム表示のコレクション。

    ワークブックのカスタム表示のコレクションを取得します。

    • index
    • タイプ:number
    • 取得するためのカスタム表示の 0 から始まるインデックス番号。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが CustomViewCollection.count 以上です。

  • dateSystem

    .dateSystem( );
    返却型:
    ig.excel.DateSystem
    返却型の説明:
    Microsoft Excel によって内部的に使用される日付システム。

    Microsoft Excel によって内部的に使用される日付システムを取得します。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Workbook.dateSystem 列挙体で定義されていません。

  • dateSystem

    .dateSystem( value:ig.excel.DateSystem );
    返却型:
    ig.excel.DateSystem
    返却型の説明:
    Microsoft Excel によって内部的に使用される日付システム。

    Microsoft Excel によって内部的に使用される日付システムを取得します。

    • value
    • タイプ:ig.excel.DateSystem

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Workbook.dateSystem 列挙体で定義されていません。

  • defaultTableStyle

    .defaultTableStyle( );

    ワークブック内のテーブルのデフォルトのスタイルを取得または取得します。

    例外

    例外 説明
    ig.ArgumentException 指定した値が、Workbook.customTableStyles または Workbook.standardTableStyles コレクションに存在しません。

    備考

    これは、Workbook.customTableStyles または Workbook.standardTableStyles コレクション内の任意の WorksheetTableStyle に設定できます。

    これは決して null 値を返しません。null に設定された場合、これは TableStyleMedium2 テーブル スタイルにリセットされます。

    この値が変更された場合、ワークブック内の既存のテーブルには適用されません。新しく作成されたテーブルのみが、ワークブック内のデフォルトのテーブル スタイルを使用します。

    関連項目

  • defaultTableStyle

    .defaultTableStyle( value:ig.excel.WorksheetTableStyle );

    ワークブック内のテーブルのデフォルトのスタイルを取得または取得します。

    • value
    • タイプ:ig.excel.WorksheetTableStyle

    例外

    例外 説明
    ig.ArgumentException 指定した値が、Workbook.customTableStyles または Workbook.standardTableStyles コレクションに存在しません。

    備考

    これは、Workbook.customTableStyles または Workbook.standardTableStyles コレクション内の任意の WorksheetTableStyle に設定できます。

    これは決して null 値を返しません。null に設定された場合、これは TableStyleMedium2 テーブル スタイルにリセットされます。

    この値が変更された場合、ワークブック内の既存のテーブルには適用されません。新しく作成されたテーブルのみが、ワークブック内のデフォルトのテーブル スタイルを使用します。

    関連項目

  • documentProperties

    .documentProperties( );
    返却型:
    ig.excel.DocumentProperties
    返却型の説明:
    ワークブック文書に関連付けられたプロパティ。

    ワークブック文書に関連付けられたプロパティを取得します。

    備考

    文書プロパティは、ワークブックの作者、タイトル、題名などのワークブックのコンテンツの詳細を提供する情報のピースです。

  • editingCulture

    .editingCulture( );

    日付の書式設定または比較などの言語固有の機能に影響する編集カルチャを取得します。

    備考

    注: EditingCulture がワークブック ファイルに保存または読み込まれない場合、ワークブックに関連付けられているか所有されているオブジェクトへアクセスおよび操作する際にのみ使用されます。

    関連項目

  • editingCulture

    .editingCulture( value:string );

    日付の書式設定または比較などの言語固有の機能に影響する編集カルチャを取得します。

    • value
    • タイプ:string

    備考

    注: EditingCulture がワークブック ファイルに保存または読み込まれない場合、ワークブックに関連付けられているか所有されているオブジェクトへアクセスおよび操作する際にのみ使用されます。

    関連項目

  • getMaxColumnCount

    .getMaxColumnCount( format:ig.excel.WorkbookFormat );
    返却型:
    number
    返却型の説明:
    書式でサポートされる最大列数。

    指定した書式でサポートされる列数を返します。

    • format
    • タイプ:ig.excel.WorkbookFormat
    • ワークブックに使用されるフォーマット。

  • getMaxRowCount

    .getMaxRowCount( format:ig.excel.WorkbookFormat );
    返却型:
    number
    返却型の説明:
    書式でサポートされる最大行数。

    指定した書式でサポートされる行数を返します。

    • format
    • タイプ:ig.excel.WorkbookFormat
    • ワークブックに使用されるフォーマット。

  • getTable

    .getTable( name:string );
    返却型:
    ig.excel.WorksheetTable
    返却型の説明:
    指定した名前を持つテーブルが存在する場合は WorksheetTable インスタンス、そうでなければ null。

    指定した名前を持つテーブルを取得します。

    • name
    • タイプ:string
    • 取得するテーブルの名前。

    備考

    テーブル名は大文字と小文字を区別せずに比較されます。

  • getWorkbookFormat

    .getWorkbookFormat( fileName:string );
    返却型:
    ig.excel.WorkbookFormat
    返却型の説明:
    ファイルのファイル拡張子に基づくワークブック形式、または正しい形式が確定できない場合は、null。

    指定したファイルのファイル拡張子に基づいて WorkbookFormat を返します。

    • fileName
    • タイプ:string
    • Excel ファイルのファイル名。

  • hasProtectionPassword

    .hasProtectionPassword( );

    Workbook がパスワードを使用して保護されるかどうかを示すブール値を返します。

    備考

    Workbook を保護するとき、パスワードはオプションです。Workbook が現在に保護され (Workbook.isProtected 参照)、保護が設定したときにパスワードが指定された場合、HasProtectionPassword は True を返します。パスワードを使用せずに Workbook を保護するには、パスワードの必要がない Workbook.protect メソッドを使用できます。

    関連項目

  • isProtected

    .isProtected( );

    Workbook が保護されているかどうかを示すブール値を返します。

    備考

    Workbook が保護されている場合、IsProtected プロパティは True を返します。Workbook が保護されている場合、表示される Worksheet、順序、Workbook のウィンドウのプロパティは Workbook.protection の値に基づいて制限される可能性があります。

    関連項目

  • isSaving

    .isSaving( );

    Workbook が保存されているかどうかを示す値を取得または設定します。

  • isValidFunctionName

    .isValidFunctionName( functionName:string );
    返却型:
    boolean
    返却型の説明:
    Microsoft Excel が機能を認識する場合は True。そうでない場合は、False。

    ワークブックが保存された時に指定した機能を Microsoft Excel が認識および解決するかどうかを示す値を取得します。

    • functionName
    • タイプ:string
    • 大文字と小文字を区別しない機能。

  • isWorkbookEncrypted

    .isWorkbookEncrypted( stream:object );
    返却型:
    boolean
    返却型の説明:
    ストリームは暗号化されたワークブックを含む場合は True。それ以外の場合は False。

    指定したストリームにあるワークブックは開くパスワードと暗号化されるかどうかを決定します。

    • stream
    • タイプ:object
    • 暗号化のために確認するストリーム。

    例外

    例外 説明
    ig.ArgumentNullException stream が null の場合に発生します。

  • iterativeCalculationsEnabled

    .iterativeCalculationsEnabled( );
    返却型:
    boolean
    返却型の説明:
    再帰数式の計算中に繰り返しが許可されるかどうかを示す値。

    循環参照の数式を計算中に繰り返しが許可されるかどうかを示す値を取得します。

    備考

    繰り返し計算が有効である場合、数式は循環参照の使用が許されるか、それが属するセルを直接または間接的に参照します。Microsoft Excel は、Workbook.maxRecursionIterations を繰り返した後、またはすべての数式値が 2 つの繰り返しの間の Workbook.maxChangeInIteration より少ない回数で変更すると、数式の繰り返し計算を停止します。

    反復計算が無効である場合、循環参照は許可されず、それが直接または間接的に属するセルを参照する数式は、Microsoft Excel でエラー メッセージを表示して、セルは Circularity エラーを含みます。

    関連項目

  • iterativeCalculationsEnabled

    .iterativeCalculationsEnabled( value:boolean );
    返却型:
    boolean
    返却型の説明:
    再帰数式の計算中に繰り返しが許可されるかどうかを示す値。

    循環参照の数式を計算中に繰り返しが許可されるかどうかを示す値を取得します。

    • value
    • タイプ:boolean

    備考

    繰り返し計算が有効である場合、数式は循環参照の使用が許されるか、それが属するセルを直接または間接的に参照します。Microsoft Excel は、Workbook.maxRecursionIterations を繰り返した後、またはすべての数式値が 2 つの繰り返しの間の Workbook.maxChangeInIteration より少ない回数で変更すると、数式の繰り返し計算を停止します。

    反復計算が無効である場合、循環参照は許可されず、それが直接または間接的に属するセルを参照する数式は、Microsoft Excel でエラー メッセージを表示して、セルは Circularity エラーを含みます。

    関連項目

  • load

    .load( data:object, loadOptions:ig.excel.WorkbookLoadOptions, successCallback:function, failCallback:function );

    Uint8Array または Base 64 エンコーディング文字列からワークブックを読み込みます。

    • data
    • タイプ:object
    • ワークブックを読み込むデータ。
    • loadOptions
    • タイプ:ig.excel.WorkbookLoadOptions
    • ストリームを読み込むために使用されるオプション。デフォルト オプションを使用する場合は null。
    • successCallback
    • タイプ:function
    • failCallback
    • タイプ:function

    例外

    例外 説明
    ig.ArgumentException data は、有効な Microsoft Excel ファイル コンテンツを含みません。
    ig.ArgumentException data は、有効な Microsoft Excel ファイル コンテンツを含みません。
    ig.InvalidOperationException ワークブック データの書式はサポートされていない書式です。
    ig.NotSupportedException ワークブックは、Excel 2007 形式で読み込まれていて、CLR 2.0 Excel アセンブリが使用されています。このケースでは、IPackageFactory を取得するオーバーロードを使用することにより Excel 2007 ファイル パッケージにアクセスできます。
    ig.documentsCore.DocumentEncryptedException ワークブックが暗号化されたときに発生します。

    備考

    ワークブックを読み込んでいるとき、形式を決定するためにファイルのコンテンツが検証されます。 結果のワークブックの Workbook.currentFormat が、読み込まれたワークブックの形式を示します。

  • load

    .load( data:object, successCallback:function, failCallback:function );

    Uint8Array または Base 64 エンコーディング文字列からワークブックを読み込みます。

    • data
    • タイプ:object
    • ワークブックを読み込むデータ。
    • successCallback
    • タイプ:function
    • failCallback
    • タイプ:function

    例外

    例外 説明
    ig.ArgumentException data は、有効な Microsoft Excel ファイル コンテンツを含みません。
    ig.ArgumentException data は、有効な Microsoft Excel ファイル コンテンツを含みません。
    ig.InvalidOperationException ワークブック データの書式はサポートされていない書式です。
    ig.NotSupportedException ワークブックは、Excel 2007 形式で読み込まれていて、CLR 2.0 Excel アセンブリが使用されています。このケースでは、IPackageFactory を取得するオーバーロードを使用することにより Excel 2007 ファイル パッケージにアクセスできます。
    ig.documentsCore.DocumentEncryptedException ワークブックが暗号化されたときに発生します。

    備考

    ワークブックを読み込んでいるとき、形式を決定するためにファイルのコンテンツが検証されます。 結果のワークブックの Workbook.currentFormat が、読み込まれたワークブックの形式を示します。

  • maxChangeInIteration

    .maxChangeInIteration( );
    返却型:
    number
    返却型の説明:
    繰り返しを終了する繰り返し間の数式で値の最大変更。

    繰り返しを終了する繰り返し間の数式で値の最大変更を取得します。

    備考

    このプロパティは Workbook.iterativeCalculationsEnabled が True の場合のみ有効です。そうでなければ、これは無視されます。

    繰り返し計算または循環参照が有効である場合、このプロパティは数式で繰り返しの計算を終了させる 2 つの繰り返しの数式のすべての値で最大の変更を決定します。繰り返しの計算は、数式が Workbook.maxRecursionIterations 回繰り返された場合も停止します。

    関連項目

  • maxChangeInIteration

    .maxChangeInIteration( value:number );
    返却型:
    number
    返却型の説明:
    繰り返しを終了する繰り返し間の数式で値の最大変更。

    繰り返しを終了する繰り返し間の数式で値の最大変更を取得します。

    • value
    • タイプ:number

    備考

    このプロパティは Workbook.iterativeCalculationsEnabled が True の場合のみ有効です。そうでなければ、これは無視されます。

    繰り返し計算または循環参照が有効である場合、このプロパティは数式で繰り返しの計算を終了させる 2 つの繰り返しの数式のすべての値で最大の変更を決定します。繰り返しの計算は、数式が Workbook.maxRecursionIterations 回繰り返された場合も停止します。

    関連項目

  • maxColumnCount

    .maxColumnCount( );

    Workbook.currentFormat に基づいて各ワークシートの列の最大数を取得します。

  • maxRecursionIterations

    .maxRecursionIterations( );
    返却型:
    number
    返却型の説明:
    数式が繰り返し計算される最大回数。

    数式が繰り返し計算される最大回数を取得します。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException 指定される値は、1 および 32767 の有効範囲の外です。

    備考

    このプロパティは Workbook.iterativeCalculationsEnabled が True の場合のみ有効です。そうでなければ、これは無視されます。

    繰り返しの計算または循環参照が有効である場合、このプロパティは計算が繰り返される時に許可される繰り返しの回数を決定します。

    関連項目

  • maxRecursionIterations

    .maxRecursionIterations( value:number );
    返却型:
    number
    返却型の説明:
    数式が繰り返し計算される最大回数。

    数式が繰り返し計算される最大回数を取得します。

    • value
    • タイプ:number

    例外

    例外 説明
    ig.ArgumentOutOfRangeException 指定される値は、1 および 32767 の有効範囲の外です。

    備考

    このプロパティは Workbook.iterativeCalculationsEnabled が True の場合のみ有効です。そうでなければ、これは無視されます。

    繰り返しの計算または循環参照が有効である場合、このプロパティは計算が繰り返される時に許可される繰り返しの回数を決定します。

    関連項目

  • maxRowCount

    .maxRowCount( );

    Workbook.currentFormat に基づいて各ワークシートの行の最大数を取得します。

  • namedReferences

    .namedReferences( );
    返却型:
    ig.excel.NamedReferenceCollection
    返却型の説明:
    このワークブック内の名前付き参照のコレクション。

    このワークブック内の名前付き参照のコレクションを取得します。

    備考

    名前付き参照は通常、名前によってセルまたはセルの範囲を参照するために使用されます。 名前付き参照の名前は、セルまたはセル範囲を明示的に命名する代わりに数式によって使用されます。

    関連項目

  • namedReferences

    .namedReferences( index:number );
    返却型:
    ig.excel.NamedReference
    返却型の説明:
    このワークブック内の名前付き参照のコレクション。

    このワークブック内の名前付き参照のコレクションを取得します。

    • index
    • タイプ:number
    • 取得する名前付き参照の 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが NamedReferenceCollection.count 以上です。

  • palette

    .palette( );

    保存済みのファイルを Microsoft Excel 2003 およびそれ以前のバージョンで開いたときに使用される色パレットを取得します。

    備考

    Microsoft Excel 2003 およびそれ以前のバージョンでファイルを開いたときに、セルおよび形状で使用される実際の色が表示されない場合があります。 その代わりに、パレット内の最も近い色が表示されます。このため、古いバージョンの Excel で色をできる限り正確に維持するために、パレットは必要に応じてカスタマイズできます。

  • palette

    .palette( index:number );

    保存済みのファイルを Microsoft Excel 2003 およびそれ以前のバージョンで開いたときに使用される色パレットを取得します。

    • index
    • タイプ:number
    • 取得または設定したいパレットの色を表すインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が、0 未満、または 55 を超える値です。
    ig.ArgumentException 割り当てられた値は色がない状態かシステム カラーまたは不透明でない色です。

    備考

    Microsoft Excel 2003 およびそれ以前のバージョンでファイルを開いたときに、セルおよび形状で使用される実際の色が表示されない場合があります。 その代わりに、パレット内の最も近い色が表示されます。このため、古いバージョンの Excel で色をできる限り正確に維持するために、パレットは必要に応じてカスタマイズできます。

    関連項目

  • palette

    .palette( index:number, value:string );

    保存済みのファイルを Microsoft Excel 2003 およびそれ以前のバージョンで開いたときに使用される色パレットを取得します。

    • index
    • タイプ:number
    • 取得または設定したいパレットの色を表すインデックス。
    • value
    • タイプ:string

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が、0 未満、または 55 を超える値です。
    ig.ArgumentException 割り当てられた値は色がない状態かシステム カラーまたは不透明でない色です。

    備考

    Microsoft Excel 2003 およびそれ以前のバージョンでファイルを開いたときに、セルおよび形状で使用される実際の色が表示されない場合があります。 その代わりに、パレット内の最も近い色が表示されます。このため、古いバージョンの Excel で色をできる限り正確に維持するために、パレットは必要に応じてカスタマイズできます。

    関連項目

  • pixelsToCharacterWidth256ths

    .pixelsToCharacterWidth256ths( pixels:number );
    返却型:
    number
    返却型の説明:
    pixels 値に相当する 平均文字幅の1/256 の単位数。

    平均文字幅の 1/256 のピクセル単位へ変換します。

    • pixels
    • タイプ:number
    • ピクセル数。

    備考

    デフォルト フォントの高さを基にした平均文字幅の 1/256 の単位。

    関連項目

  • precision

    .precision( );
    返却型:
    ig.excel.Precision
    返却型の説明:
    セルの値を取得する時に使用する精度。

    セルの値を取得する時に使用する精度を取得します。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Precision 列挙体で定義されていません。

    備考

    精度はセルの実際の値またはセルの表示値を使用するかどうかを決定します。 これらは通常は同じですが、セルの書式は表示された値では精度を失う場合があります。たとえば、セルの値が 18.975 で、通貨書式がセルで使用される場合、表示値は 18.98 になります。

  • precision

    .precision( value:ig.excel.Precision );
    返却型:
    ig.excel.Precision
    返却型の説明:
    セルの値を取得する時に使用する精度。

    セルの値を取得する時に使用する精度を取得します。

    • value
    • タイプ:ig.excel.Precision

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 割り当てた値が Precision 列挙体で定義されていません。

    備考

    精度はセルの実際の値またはセルの表示値を使用するかどうかを決定します。 これらは通常は同じですが、セルの書式は表示された値では精度を失う場合があります。たとえば、セルの値が 18.975 で、通貨書式がセルで使用される場合、表示値は 18.98 になります。

  • protect

    .protect( [allowEditStructure:boolean], [allowEditWindows:boolean] );

    パスワードを使用せずに Workbook を保護します。

    備考

    Workbook がパスワードを使用せずに保護される場合、エンド ユーザーは Excel で Workbook の保護をパスワードを入力せずに解除できます。Workbook をコードで保護を解除するには、Workbook.unprotect メソッドを使用できます。

    Workbook が保護される場合、この Workbook の Workbook.protection プロパティの WorkbookProtection インスタンスのプロパティの値は無効な操作を示します。

    注: Workbook.isProtected が既に True の場合、メソッドは無視されます。

    関連項目

  • protection

    .protection( );

    Workbook が保護されるときに使用される情報を提供するオブジェクトを返します。

    関連項目

  • recalculate

    .recalculate( );

    ワークブックにすべての計算が保留されているダーティ数式を再計算します。

    備考

    Workbook.calculationMode が Manual の場合に使用できます。Manual モードでは、セルがダーティされると Recalculate が呼び出されるか Workbook.recalculateBeforeSave が True、およびワークブックが保存されるまでは、そのセルを参照する数式は再計算されません。

    ダーティではない数式の再計算を実行するには、Workbook.recalculate オーバーロードを使用して includeNonDirtyFormulas パラメーターを True に設定します。

    関連項目

  • recalculate

    .recalculate( includeNonDirtyFormulas:boolean );

    ワークブックにすべての計算が保留されているダーティ数式を再計算します。

    • includeNonDirtyFormulas
    • タイプ:boolean
    • 保留中の評価があるかどうかと関係なくワークブックのすべての数式を再計算するには True を設定します。ダーティ数式のみを計算するには False を設定します。

    備考

    Workbook.calculationMode が Manual の場合に使用できます。Manual モードでは、セルがダーティされると Recalculate が呼び出されるか Workbook.recalculateBeforeSave が True、およびワークブックが保存されるまでは、そのセルを参照する数式は再計算されません。

    ダーティではない数式の再計算を実行するには、Workbook.recalculate オーバーロードを使用して includeNonDirtyFormulas パラメーターを True に設定します。

    関連項目

  • recalculateBeforeSave

    .recalculateBeforeSave( );
    返却型:
    boolean
    返却型の説明:
    ワークブックが保存前にすべての数式を再計算するかどうかを示す値。

    ワークブックが保存前にすべての数式を再計算するかどうかを示す値を取得します。

    備考

    このプロパティは、Workbook.calculationMode が Manual の場合に限って適用されます。そうでなければ、これは無視されます。

    関連項目

  • recalculateBeforeSave

    .recalculateBeforeSave( value:boolean );
    返却型:
    boolean
    返却型の説明:
    ワークブックが保存前にすべての数式を再計算するかどうかを示す値。

    ワークブックが保存前にすべての数式を再計算するかどうかを示す値を取得します。

    • value
    • タイプ:boolean

    備考

    このプロパティは、Workbook.calculationMode が Manual の場合に限って適用されます。そうでなければ、これは無視されます。

    関連項目

  • registerUserDefinedFunction

    .registerUserDefinedFunction( userDefinedFunction:ig.excel.ExcelCalcFunction );
    返却型:
    boolean
    返却型の説明:
    型が正常に登録された場合は True、登録が失敗した場合は False を返します。

    1 つの ExcelCalcFunction インスタンスを登録します。

    • userDefinedFunction
    • タイプ:ig.excel.ExcelCalcFunction
    • 登録するユーザー定義関数のインスタンス。

    備考

    ExcelCalcFunction クラスをサブクラス化することによって、数式で使用するカスタム関数を作成できます。 インスタンス化された派生クラスを数式から利用できるようにするためには、RegisterUserDefinedFunction メソッドを使用して派生クラスを登録する必要があります。

  • resumeCalculations

    .resumeCalculations( );

    数式の計算を再開します。

    備考

    これが呼び出された時に全ての計算が中断されていない場合には、効果がなくなります。

    Workbook.suspendCalculations を呼び出す度に、ResumeCalculations を呼ぶ出す必要があります。ResumeCalculations の呼び出し数が、SuspendCalculations の呼び出し数以上になると計算が再開します。

    関連項目

  • save

    .save( saveOptions:ig.excel.WorkbookSaveOptions, successCallback:function, failCallback:function );

    ワークブックを Uint8Array に書き出します。

    • saveOptions
    • タイプ:ig.excel.WorkbookSaveOptions
    • ストリームを保存するために使用されるオプション。デフォルト オプションを使用する場合は null。
    • successCallback
    • タイプ:function
    • failCallback
    • タイプ:function

    例外

    例外 説明
    ig.InvalidOperationException ワークブックには、Workbook.worksheets コレクションにワークシートはありません。
    ig.InvalidOperationException ワークブックには、Workbook.worksheets コレクションにワークシートはありません。
    ig.InvalidOperationException ワークブックには、Workbook.worksheets コレクションにワークシートはありません。

    備考

    ワークブックは Workbook.currentFormat で指定された書式で書き出されます。

    関連項目

  • save

    .save( successCallback:function, failCallback:function );

    ワークブックを Uint8Array に書き出します。

    • successCallback
    • タイプ:function
    • failCallback
    • タイプ:function

    例外

    例外 説明
    ig.InvalidOperationException ワークブックには、Workbook.worksheets コレクションにワークシートはありません。
    ig.InvalidOperationException ワークブックには、Workbook.worksheets コレクションにワークシートはありません。
    ig.InvalidOperationException ワークブックには、Workbook.worksheets コレクションにワークシートはありません。

    備考

    ワークブックは Workbook.currentFormat で指定された書式で書き出されます。

    関連項目

  • saveExternalLinkedValues

    .saveExternalLinkedValues( );
    返却型:
    boolean
    返却型の説明:
    外部のワークブックからリンクされる値を保存するかどうかを示す値。

    外部のワークブックからリンクされる値を保存するかどうかを示す値を取得します。

    備考

    この値は、Microsoft Excel でワークブックが開かれた時に限って使用されます。外部値を参照して Excel アセンブリからワークブックを保存する場合、外部にリンクされた値は保存されません。

  • saveExternalLinkedValues

    .saveExternalLinkedValues( value:boolean );
    返却型:
    boolean
    返却型の説明:
    外部のワークブックからリンクされる値を保存するかどうかを示す値。

    外部のワークブックからリンクされる値を保存するかどうかを示す値を取得します。

    • value
    • タイプ:boolean

    備考

    この値は、Microsoft Excel でワークブックが開かれた時に限って使用されます。外部値を参照して Excel アセンブリからワークブックを保存する場合、外部にリンクされた値は保存されません。

  • screenDpi

    .screenDpi( );
    返却型:
    object
    返却型の説明:
    これは、'width' および 'height' プロパティで数値があるオブジェクトです。

    ワークブックの行および列のサイズを計算するときに使用する Dpi を取得します。空の場合、システム Dpi が使用されます。

    例外

    例外 説明
    ig.ArgumentException 指定した値は空ではなく、2 つの正の値がない場合に発生します。

  • screenDpi

    .screenDpi( value:object );
    返却型:
    object
    返却型の説明:
    これは、'width' および 'height' プロパティで数値があるオブジェクトです。

    ワークブックの行および列のサイズを計算するときに使用する Dpi を取得します。空の場合、システム Dpi が使用されます。

    • value
    • タイプ:object
    • これは、'width' および 'height' プロパティで数値があるオブジェクトです。例: { width: 1, height: 2 }。

    例外

    例外 説明
    ig.ArgumentException 指定した値は空ではなく、2 つの正の値がない場合に発生します。

  • setCurrentFormat

    .setCurrentFormat( format:ig.excel.WorkbookFormat );

    ワークブックの現在フォーマットを設定します。

    • format
    • タイプ:ig.excel.WorkbookFormat
    • 形式制限の設定と保存をする時に使用するファイル形式です。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException 書式が WorkbookFormat 列挙体で定義されていません。
    ig.InvalidOperationException ワークブックは format が設定した制限を超えるデータを含みます。

    関連項目

  • sheets

    .sheets( );
    返却型:
    ig.excel.SheetCollection
    返却型の説明:

    備考

  • sheets

    .sheets( index:number );
    返却型:
    ig.excel.Sheet
    返却型の説明:

    • index
    • タイプ:number

    例外

    例外 説明
    ig.ArgumentOutOfRangeException

  • sheets

    .sheets( name:string );
    返却型:
    ig.excel.Sheet
    返却型の説明:

    • name
    • タイプ:string

    例外

    例外 説明
    ig.InvalidOperationException

    備考

    関連項目

  • shouldRemoveCarriageReturnsOnSave

    .shouldRemoveCarriageReturnsOnSave( );
    返却型:
    boolean
    返却型の説明:
    保存したワークブックは、セルの値から復帰文字を含まない場合は True。セルに設定されている文字列の値をエクスポートする場合は、False。

    ワークブックが Excel ファイルへ保存される時にセルの文字列の値から改行文字が削除される必要があるかどうかを示す値を取得します。

    備考

    Microsoft Excel 2003 では、復帰文字がボックスとして表示されます。殆どの場合には改行文字を表示する必要はなく、削除されてもセル内のテキスト レイアウトに影響はありません。このプロパティのデフォルトは True です。

  • shouldRemoveCarriageReturnsOnSave

    .shouldRemoveCarriageReturnsOnSave( value:boolean );
    返却型:
    boolean
    返却型の説明:
    保存したワークブックは、セルの値から復帰文字を含まない場合は True。セルに設定されている文字列の値をエクスポートする場合は、False。

    ワークブックが Excel ファイルへ保存される時にセルの文字列の値から改行文字が削除される必要があるかどうかを示す値を取得します。

    • value
    • タイプ:boolean

    備考

    Microsoft Excel 2003 では、復帰文字がボックスとして表示されます。殆どの場合には改行文字を表示する必要はなく、削除されてもセル内のテキスト レイアウトに影響はありません。このプロパティのデフォルトは True です。

  • standardTableStyles

    .standardTableStyles( );

    ワークブック内のプリセットのテーブル スタイルの読み取り専用コレクションを取得します。

    関連項目

  • standardTableStyles

    .standardTableStyles( index:number );
    返却型:
    ig.excel.WorksheetTableStyle
    返却型の説明:
    指定したインデックスにある WorksheetTableStyle インスタンス。

    ワークブック内のプリセットのテーブル スタイルの読み取り専用コレクションを取得します。

    • index
    • タイプ:number
    • 取得したい WorksheetTableStyle の位置を示すインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、または StandardTableStyleCollection.count 以上の値です。

  • standardTableStyles

    .standardTableStyles( name:string );
    返却型:
    ig.excel.WorksheetTableStyle
    返却型の説明:
    指定したインデックスにある WorksheetTableStyle インスタンス。

    ワークブック内のプリセットのテーブル スタイルの読み取り専用コレクションを取得します。

    • name
    • タイプ:string
    • 調べたい WorksheetTableStyle の名前。

    備考

    テーブル スタイル名は大文字と小文字を区別せずに比較されます。

  • styles

    .styles( );
    返却型:
    ig.excel.WorkbookStyleCollection
    返却型の説明:
    このワークブック内のカスタム スタイルのコレクション。

    このワークブック内のカスタム スタイルのコレクションを取得します。

    備考

    このコレクションは、Excel ワークブックにカスタムスタイルを追加するために使用します。ユーザーは Excel ワークブックのさまざまな部分にそのスタイルを適用することで、複雑な書式設定を容易に設定できます。

    関連項目

  • styles

    .styles( index:number );
    返却型:
    ig.excel.WorkbookStyle
    返却型の説明:
    このワークブック内のカスタム スタイルのコレクション。

    このワークブック内のカスタム スタイルのコレクションを取得します。

    • index
    • タイプ:number
    • 取得するスタイルの 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorkbookStyleCollection.count 以上です。

  • styles

    .styles( name:string );
    返却型:
    ig.excel.WorkbookStyle
    返却型の説明:
    このワークブック内のカスタム スタイルのコレクション。

    このワークブック内のカスタム スタイルのコレクションを取得します。

    • name
    • タイプ:string
    • 取得するスタイルの名前。

    例外

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

    備考

    このコレクションは、Excel ワークブックにカスタムスタイルを追加するために使用します。ユーザーは Excel ワークブックのさまざまな部分にそのスタイルを適用することで、複雑な書式設定を容易に設定できます。

  • suspendCalculations

    .suspendCalculations( );

    数式の計算を一時的に中断します。

    備考

    これは、さまざまな数式を追加したりワークブックの膨大なデータを変更したりする場合に一度だけ使用されます。それによりセルがダーティーされるたびに数式が計算されることがなくなります。

    Workbook.resumeCalculations を呼び出す度に、ResumeCalculations を呼ぶ出す必要があります。ResumeCalculations の呼び出し数が、SuspendCalculations の呼び出し数以上になると計算が再開します。

    関連項目

  • unprotect

    .unprotect( );

    Workbook 保護を解除します。

    関連項目

  • validateFormatStrings

    .validateFormatStrings( );

    設定される時に書式文字列の検証を実行するかどうかを示す値を取得します。

    備考

    後方互換性を維持するためにこの値はデフォルトで False です。

    True の場合、IWorksheetCellFormat.formatString プロパティが設定されると書式文字列の検証が実行されます。無効な書式文字列は例外の原因になります。False の場合、無効な書式文字列が許可されますが、セルの表示テキストが要求されると、その時には例外がスローされます。無効な書式文字列が許可され、ワークブックが保存されて Microsoft Excel で開かれる場合、エラーを表示します。

    関連項目

  • validateFormatStrings

    .validateFormatStrings( value:boolean );

    設定される時に書式文字列の検証を実行するかどうかを示す値を取得します。

    • value
    • タイプ:boolean

    備考

    後方互換性を維持するためにこの値はデフォルトで False です。

    True の場合、IWorksheetCellFormat.formatString プロパティが設定されると書式文字列の検証が実行されます。無効な書式文字列は例外の原因になります。False の場合、無効な書式文字列が許可されますが、セルの表示テキストが要求されると、その時には例外がスローされます。無効な書式文字列が許可され、ワークブックが保存されて Microsoft Excel で開かれる場合、エラーを表示します。

    関連項目

  • windowOptions

    .windowOptions( );
    返却型:
    ig.excel.WorkbookWindowOptions
    返却型の説明:
    さまざまなワークブック レベルの表示プロパティを制御するオプション。

    さまざまなワークブック レベルの表示プロパティを制御するオプションを取得します。

    備考

    ウィンドウ オプションは、Microsoft Excel のワークブックを表示する子 MDIウィンドウのプロパティを制御します。 これらは選択したワークシートに基づき変更しないワークブックの表示オプションも制御します。

    関連項目

  • worksheets

    .worksheets( );
    返却型:
    ig.excel.WorksheetCollection
    返却型の説明:
    このワークブック内のワークシートのコレクション。

    このワークブック内のワークシートのコレクションを取得します。

    備考

    WindowOptions.SelectedWorksheet を使用して選択するワークシートを設定します。選択したワークシートは、Microsoft Excel でワークブックを開いた時に表示されるワークシートです。

  • worksheets

    .worksheets( index:number );
    返却型:
    ig.excel.Worksheet
    返却型の説明:
    このワークブック内のワークシートのコレクション。

    このワークブック内のワークシートのコレクションを取得します。

    • index
    • タイプ:number
    • 取得するワークシートの 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetCollection.count 以上です。

  • worksheets

    .worksheets( name:string );
    返却型:
    ig.excel.Worksheet
    返却型の説明:
    このワークブック内のワークシートのコレクション。

    このワークブック内のワークシートのコレクションを取得します。

    • name
    • タイプ:string
    • 取得するワークシートの名前。

    例外

    例外 説明
    ig.InvalidOperationException 指定した名前のワークシートはコレクションに存在しません。

    備考

    WindowOptions.SelectedWorksheet を使用して選択するワークシートを設定します。選択したワークシートは、Microsoft Excel でワークブックを開いた時に表示されるワークシートです。

    関連項目

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