このトピックでは、表のエクスポート、ワークシート名の取得、ワークシートの切り替え、オペレーター情報の取得、クリップボードイベントのリスニング方法について説明します。
表ドキュメントのエクスポート
表ドキュメント全体のエクスポート
表ドキュメント全体をPDFファイルまたは画像ファイルとしてエクスポートし、エクスポートされたファイルのURLを取得します。
構文
Expression.ActiveWorkbook.ExportAsFixedFormat({ Type }
式:ドキュメントタイプのアプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Type
Enum
いいえ
表ドキュメントのエクスポート先のファイルの種類。
Enum.XlFixedFormatType
の有効な値:0またはxlTypePDF:PDF形式。
1またはxlTypeXPS:XML Paper Specification(XPS)形式。この形式はサポートされていません。
2またはxlTypeIMG:IMG形式。
戻り値
パラメーター
データ型
説明
url
string
エクスポートされたファイルのURL。
例
表ドキュメントをPDFファイルとしてエクスポートする
async function example() { await instance.ready(); const app = instance.Application; // 表ドキュメント全体をエクスポートします。 const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat(); console.log(workbookPdfUrl); }
表ドキュメントを画像ファイルとしてエクスポートする
async function example() { await instance.ready(); const app = instance.Application; // 表ドキュメント全体をエクスポートします。 const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat({ Type: app.Enum.XlFixedFormatType.xlTypeIMG, }); console.log(workbookPdfUrl); }
現在のワークシートのエクスポート
現在のワークシートをPDFファイルまたは画像ファイルとしてエクスポートし、エクスポートされたファイルのURLを取得します。
構文
Expression.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({ Type }
式:ドキュメントタイプのアプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Type
Enum
いいえ
表ドキュメントのエクスポート先のファイルの種類。
Enum.XlFixedFormatType
の有効な値:0またはxlTypePDF:PDF形式。
1またはxlTypeXPS:XML Paper Specification(XPS)形式。この形式はサポートされていません。
2またはxlTypeIMG:IMG形式。
戻り値
パラメーター
データ型
説明
url
string
エクスポートされたファイルのURL。
例
現在のワークシートをPDFファイルとしてエクスポートする
async function example() { await instance.ready(); const app = instance.Application; // 現在のワークシートをエクスポートします。 const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat(); console.log(workbookPdfUrl); }
現在のワークシートを画像ファイルとしてエクスポートする
async function example() { await instance.ready(); const app = instance.Application; // 現在のワークシートをエクスポートします。 const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({ Type: app.Enum.XlFixedFormatType.xlTypeIMG, }); console.log(workbookPdfUrl); }
ワークシート名の取得
現在のワークシートの名前を取得する
構文
Expression.ActiveWorkbook.ActiveSheet.Name
式:ドキュメントタイプのアプリケーションオブジェクト。
戻り値
ワークシートの名前を表す
string
を返します。例
async function example() { await instance.ready(); const app = instance.Application; // 現在のワークシートの名前を取得します。 const name = await app.ActiveWorkbook.ActiveSheet.Name; console.log(name); }
ワークシートの切り替え
指定したワークシートに切り替える
構文
Expression.ActiveWorkbook.Sheets.Item(Index).Activate()
Expression.Sheets(Index).Activate()
式:ドキュメントタイプのアプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Index
Number
はい
ワークシートのインデックス番号。
例
例1:
async function example() { await instance.ready(); const app = instance.Application; // 指定したワークシートに切り替えます。 const sheetIndex = 2; // ワークシートのインデックス番号。番号は1から始まります。 app.ActiveWorkbook.Sheets.Item(sheetIndex).Activate(); }
例2
async function example() { await instance.ready(); const app = instance.Application; // 指定したワークシートに切り替えます。 const sheetIndex = 2; // ワークシートのインデックス番号。番号は1から始まります。 app.Sheets(sheetIndex).Activate(); }
ワークシート切り替えイベントをリスニングする
構文
Expression.Sub.Worksheet_Activate = Function
式:ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ワークシートの切り替えイベントをリスニングします。 app.Sub.Worksheet_Activate = async () => { console.log('ActiveSheet:', await app.ActiveSheet.Name); }; }
オペレーター情報の取得
現在のオペレーターに関する情報を取得します。
構文
Expression.ActiveWorkbook.GetOperatorsInfo()
式:ドキュメントタイプのアプリケーションオブジェクト。
戻り値
オブジェクトオブジェクト
パラメーター
データ型
説明
type
String
リクエストタイプ。
response
Object
ユーザーに関する詳細。
responseパラメーターの構造
パラメーター
データ型
説明
id
String
ユーザーID。
avatar_url
Object
ユーザーのプロフィール画像。
logined
Object
ユーザーのログオン状態。
name
Object
ユーザーの名前。
例
async function example() { await instance.ready(); const app = instance.Application; // 現在のオペレーターの情報を取得します。 const operatorsInfo = await app.ActiveWorkbook.GetOperatorsInfo(); console.log(operatorsInfo); }
クリップボードイベントのリスニング
コピー操作をリスニングします。
構文
Expression.Sub.Clipboard_Copy = Function
式:ドキュメントタイプのアプリケーションオブジェクト。
戻り値
パラメーター
データ型
説明
copyId
String
コピー操作のID。
isRestoreFocus
Boolean
未定義。
text
String
コピーされたコンテンツ。
例
async function example() { await instance.ready(); const app = instance.Application; // コピー操作をリスニングします。 app.Sub.Clipboard_Copy = async (e) => { await console.log(e); } }
ズーム率の設定
ウィンドウのズーム率を設定します。
構文
Expression.ActiveWindow.Zoom
式:ドキュメントタイプのアプリケーションオブジェクト。
戻り値
ズーム率を表す
number
を返します。例
async function example() { await instance.ready(); const app = instance.Application; // ズーム率を取得します。 const zoom = await app.ActiveWindow.Zoom; console.log(zoom); // ズーム率を設定します。 app.ActiveWindow.Zoom = 10; }
グリッド線の表示/非表示
グリッド線を表示または非表示にします。
構文
Expression.ActiveWindow.DisplayGridlines = Boolean
式:ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // グリッド線を非表示にします。 app.ActiveWindow.DisplayGridlines = false; }
見出しの表示/非表示
行と列の見出しを表示または非表示にします。
構文
Expression.ActiveWindow.DisplayHeadings = Boolean
式:ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // 行と列の見出しを非表示にします。 app.ActiveWindow.DisplayHeadings = false; }
ドキュメントの保存
ドキュメントへの変更を保存します。
JS-SDK V1.1.9以降でこの機能がサポートされています。
構文
Expression.ActiveWorkbook.Save()
式:ドキュメントタイプのアプリケーションオブジェクト。
戻り値
パラメーター
データ型
説明
result
String
保存状態。
size
Number
ドキュメントのサイズ。単位:バイト。
version
Number
バージョン番号。
保存状態の説明
保存状態
説明
ok
バージョンが保存されました。ドキュメントの履歴バージョンで保存されたバージョンを表示できます。
nochange
ドキュメントは更新されていません。バージョンを保存する必要はありません。
SavedEmptyFile
ドキュメントは空で、保存できません。
この状態は、カーネルの保存後にドキュメントが空の場合に返されます。
SpaceFull
ストレージ容量が不足しています。
QueneFull
ドキュメントの保存中に頻繁な保存操作は許可されていません。
この状態は、サーバー上の保存操作キューがいっぱいの場合に返されます。
fail
ドキュメントの保存に失敗しました。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメントへの変更を保存します。 const saveResult = await app.ActiveWorkbook.Save(); console.log(saveResult); }
カードビューの状態を変更する
JS-SDK V1.1.15以降でこの機能がサポートされています。
構文
Expression.ActiveWorkbook.SwitchCardView()
式:ドキュメントタイプのアプリケーションオブジェクト。
パラメーター
ブール型の値を指定して、カードビューの状態を変更します。
パラメーター
データ型
必須
説明
Status
Boolean
はい
カードビューをオンにすることのみ可能です。
例
async function example() { await instance.ready(); const app = instance.Application; // カードビューをオンにします。 await app.ActiveWorkbook.SwitchCardView(true); }