このトピックでは、Word ドキュメントの Revision オブジェクトに関連する API 操作について説明します。
リビジョン
ActiveDocument.Revisions
ドキュメント内のすべてのリビジョンを取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisionsexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; }
メソッド
ActiveDocument.Revisions.AcceptAll()
ドキュメント内のすべての変更を承諾します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.AcceptAll()expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内のすべてのリビジョンを承諾します。 await revisions.AcceptAll(); }
ActiveDocument.Revisions.Item()
ドキュメントの Revisions コレクションから、指定された Revision オブジェクトを取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index)expression: アプリケーション オブジェクト。
パラメーター
パラメーター
型
必須
説明
Index
Number
はい
取得する Revision オブジェクトのインデックス番号。
例
async function example() { await instance.ready(); const app = instance.Application; // Revisions コレクションを取得します。 const Revisions = await app.ActiveDocument.Revisions; // Revisions コレクションから単一の Revision オブジェクトを取得します。 await Revisions.Item(1); }
ActiveDocument.Revisions.Json()
ドキュメント内のすべてのリビジョン データを取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Json()expression: アプリケーション オブジェクト。
戻り値
[{ user, ... }]などの項目を含むArray.<Object>形式のすべてのリビジョンの内容。次の表は、戻り値について説明しています。パラメーター
型
説明
user
String
ユーザー名。
leader
String
リビジョンに関するコメント。
begin
String
リビジョンの開始位置。
end
String
リビジョンの終了位置。
content
String
リビジョンの内容。
type
String
リビジョンの種類。
date
Number
リビジョンが行われた時点を示すタイムスタンプ。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // すべてのリビジョンの内容を取得します。 const revisionData = await revisions.Json(); console.log(revisionData); }
ActiveDocument.Revisions.RejectAll()
ドキュメント内のすべてのリビジョンを拒否します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.RejectAll()expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // すべてのリビジョンを拒否します。 await revisions.RejectAll(); }
ActiveDocument.Revisions.SwitchRevisionBtn()
承諾 ボタンと 拒否 ボタンを表示するか非表示にするかを設定します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.SwitchRevisionBtn({ Value })expression: アプリケーション オブジェクト。
パラメーター
ValueはBoolean型です。trueを指定すると、承諾 ボタンと 拒否 ボタンが表示されます。falseを指定すると、ボタンは非表示になります。例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // 承諾 ボタンと 拒否 ボタンを非表示にします。 await revisions.SwitchRevisionBtn(false); }
ActiveDocument.Revisions.SetRevisionMarkVisibilityByUserInfo()
ユーザー名別にリビジョンの表示/非表示を設定します。表示設定は現在のページにのみ有効です。ページを更新すると、ページの表示設定は無効になります。
この機能は、IMM WebOffice SDK for JavaScript V1.1.12 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.SetRevisionMarkVisibilityByUserInfo(UserInfos)expression: アプリケーション オブジェクト。
パラメーター
次の表は、
UserInfos配列のパラメーターについて説明しています。パラメーター
型
必須
説明
userName
String
いいえ
ユーザー名。
visible
Boolean
いいえ
リビジョンを表示するかどうかを指定します。有効な値:
false (デフォルト)
true
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // リビジョンを非表示にします。 await revisions.SetRevisionMarkVisibilityByUserInfo([{ userName: "user01", visible: false }]); }
プロパティ
ActiveDocument.Revisions.Count
ドキュメント内のリビジョンの総数を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Countexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // リビジョンの総数を取得します。 const count = await revisions.Count; console.log(count); }
ActiveDocument.Revisions.RevisionsMode
ドキュメント内のすべてのリビジョンをインライン モードで表示します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.16 以降でのみサポートされています。
構文
expression.RevisionsModeexpression: アプリケーション オブジェクト。
0はデフォルト モードを指定します。1はインライン モードを指定します。例
//@file=base.docx async function example() { await instance.ready(); const app = instance.Application; const revisions = await app.ActiveDocument.Revisions; revisions.RevisionsMode = 1; }
ActiveDocument.Revisions.ShowRevisionsFrame
変更履歴バルーンを表示するかどうかを設定します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ShowRevisionsFrameexpression: アプリケーション オブジェクト。
trueは変更履歴バルーンを表示することを指定し、falseは変更履歴バルーンを非表示にすることを指定します。例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // 変更履歴バルーンを表示します。 revisions.ShowRevisionsFrame = true; }
リビジョン
ActiveDocument.Revisions.Item()
単一の Revision オブジェクトを取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index)expression: アプリケーション オブジェクト。
パラメーター
パラメーター
型
必須
説明
Index
Number
はい
取得する Revision オブジェクトのインデックス番号。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); }
メソッド
ActiveDocument.Revisions.Item(Index).Accept()
単一のリビジョンを承諾します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).Accept()expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); // 最初のリビジョンを承諾します。 await revision.Accept(); }
ActiveDocument.Revisions.Item(Index).Reject()
単一のリビジョンを拒否します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).Reject()expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); // 最初のリビジョンを拒否します。 await revision.Reject(); }
プロパティ
ActiveDocument.Revisions.Item(Index).Author
指定されたリビジョンを行ったユーザーの名前を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).Authorexpression: アプリケーション オブジェクト。
戻り値
レビュー担当者の名前を示す
String。例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); // リビジョンを行ったレビュー担当者の名前を取得します。 const author = await revision.Author; console.log(author); }
ActiveDocument.Revisions.Item(Index).Date
指定されたリビジョンが行われた日時を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).Authorexpression: アプリケーション オブジェクト。
戻り値
リビジョンが行われた日時を示す
Dateオブジェクト。例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); // リビジョンが行われた日時を取得します。 const date = await revision.Date; console.log(date); }
ActiveDocument.Revisions.Item(Index).Range
指定されたリビジョンの範囲を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).Rangeexpression: アプリケーション オブジェクト。
戻り値
リビジョンの範囲を示す
Range。例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); // リビジョンの範囲を取得します。 const range = await revision.Range; console.log(range); }
ActiveDocument.Revisions.Item(Index).Type
指定されたリビジョンの種類を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).Typeexpression: アプリケーション オブジェクト。
戻り値
リビジョンの種類を示す
Enum。詳細については、「WdRevisionType」をご参照ください。例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // ドキュメント内の最初のリビジョンを取得します。 const revision = await revisions.Item(1); // リビジョンの種類を取得します。 const type = await revision.Type; console.log(type); }
ActiveDocument.Revisions.Item(Index).userID
指定されたリビジョンを行ったレビュー担当者の ID を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.19 以降でのみサポートされています。
構文
expression.ActiveDocument.Revisions.Item(Index).userID
expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); // ドキュメント内のすべてのリビジョンを取得します。 const revisions = await app.ActiveDocument.Revisions; // 指定されたリビジョンを取得します。 const revision = await revisions.Item(1); // リビジョンを行ったレビュー担当者の ID を取得します。 const type = await revision.userID; console.log(type); }
RevisionsFilter
ActiveDocument.ActiveWindow.View.RevisionsFilter
ドキュメント内のリビジョンの表示に関連する現在の設定を取得します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.ActiveWindow.View.RevisionsFilterexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のリビジョンの表示に関連する現在の設定を取得します。 const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter; }
プロパティ
ActiveDocument.ActiveWindow.View.RevisionsFilter.View
ドキュメントの元のバージョンと最終バージョンのどちらを表示するかを設定します。
この機能は、IMM WebOffice SDK for JavaScript V1.1.10 以降でのみサポートされています。
構文
expression.ActiveDocument.ActiveWindow.View.RevisionsFilter.Viewexpression: アプリケーション オブジェクト。
0 は最終バージョンを指定し、1 は元のバージョンを指定します。
例
async function example() { await instance.ready(); const app = instance.Application; // ドキュメント内のリビジョンの表示に関連する現在の設定を取得します。 const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter; // ドキュメントの元のバージョンを表示します。 RevisionsFilter.View = 1; }