Class App

osbxlのアプリケーション起動クラスです。

Excelファイルの新規作成、既存ファイルの読み込みを行います。各種ユーティリティ(セル範囲←→数値や日付←→数値)も備え持ちます。

Constructors

constructor

Methods

convertFromColumnNumber convertFromRowColNumber convertFromRowColNumber2 convertToColumnNumber createWorkBook getNumericValue getVersion openPasswordWorkBook openWorkBook

Constructors

constructor

  • new App(): App

  • コンストラクタ。osbxl.Appのインスタンスを生成します。

    Returns App

Methods

convertFromColumnNumber

  • convertFromColumnNumber(colNumber, absDisplay?): string

  • 列の数値表記をA1表記に変換します。

    1. 列番号は1から始まります。(A列が、1です)

    Parameters

    • colNumber: number

      列番号

    • absDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    Returns string

    A1表記

convertFromRowColNumber

  • convertFromRowColNumber(rowNumber, colNumber, absRowDisplay?, absColDisplay?): string

  • セルの数値表記をA1C1表記にに変換します。

    1. 列番号、行番号は、1から始まります。((1,1)は、A1となります)

    Parameters

    • rowNumber: number

      行番号

    • colNumber: number

      列番号

    • absRowDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    • absColDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    Returns string

    A1表記

convertFromRowColNumber2

  • convertFromRowColNumber2(startRowNumber, startColNumber, endRowNumber, endColNumber, absStartRowDisplay?, absStartColDisplay?, absEndRowDisplay?, absEndColDisplay?): string

  • セル範囲の数値表記をA1C1表記にに変換します。

    1. 列番号、行番号は、1から始まります。((1,1)は、A1となります)

    Parameters

    • startRowNumber: number

      先頭行番号

    • startColNumber: number

      先頭列番号

    • endRowNumber: number

      末尾行番号

    • endColNumber: number

      末尾列番号

    • absStartRowDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    • absStartColDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    • absEndRowDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    • absEndColDisplay: boolean = false

      trueの場合、$付き表記(セルの絶対参照)で取得します。

    Returns string

    A1C1表記

convertToColumnNumber

  • convertToColumnNumber(A1): number

  • 列のA1表記を数値型表記に変換します。

    1. 返却値は、1から始まります。

    Parameters

    • A1: string

      A1表記

    Returns number

    列の数値変換値

createWorkBook

  • createWorkBook(bookPath, defalutFont?, defaultFontSize?): WorkBook

  • ワークブックを作成します。

    1. 作成可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
    2. ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

    Parameters

    • bookPath: string

      ワークブックのファイルパス

    • defalutFont: XlFont = enums.XlFont.YU_GOTHIC

      フォント列挙体

    • defaultFontSize: number = 11.0

      フォントサイズ

    Returns WorkBook

    作成したワークブックのワークブッククラス

getNumericValue

  • getNumericValue(dateTimeObject, is1904?): number

  • 日付時刻型オブジェクトからExcel内部でもっている数値の値(シリアル値)を取得します。

    Parameters

    • dateTimeObject: DateTimeObject

      変換元日付時刻型オブジェクト 最小値は、is1904メソッドに依存した値となり、最大値は、9999/12/31となります。

    • is1904: boolean = false

      ワークブックの年月が1904年形式(最小値が1904/1/1)の場合: true, 通常(最小値が1900/1/1)の場合: false

    Returns number

    シリアル値

getVersion

  • getVersion(): string

  • アプリケーションのバージョンを取得します。

    Returns string

    アプリケーションのバージョン

openPasswordWorkBook

  • openPasswordWorkBook(bookPath, passWord): WorkBook

  • パスワード付きワークブックを開きます。

    1. 読み込み可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
    2. ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

    Parameters

    • bookPath: string

      ワークブックのファイルパス

    • passWord: string

      パスワード

    Returns WorkBook

    ワークブッククラス

    Throws

    IOError ファイルパスが存在しない場合

openWorkBook

  • openWorkBook(bookPath): WorkBook

  • ワークブックを開きます。

    1. 読み込み可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
    2. ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

    Parameters

    • bookPath: string

      ワークブックのファイルパス

    Returns WorkBook

    ワークブッククラス

    Throws

    IOError ファイルパスが存在しない場合

Settings

Member Visibility

Theme

On This Page

   Copyright © 2023. OSB-OFFICE.Inc, All rights reserved.   Generated using TypeDoc